diff --git a/release/fraudPreventionV2/docs/client/classes/class.FraudPreventionV2Client.md b/release/fraudPreventionV2/docs/client/classes/class.FraudPreventionV2Client.md deleted file mode 100644 index 61dbb202..00000000 --- a/release/fraudPreventionV2/docs/client/classes/class.FraudPreventionV2Client.md +++ /dev/null @@ -1,279 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [client](../index.md) > FraudPreventionV2Client - -# Class: FraudPreventionV2Client - -## Extends - -- [`Client`](../../models/core/classes/class.Client.md) - -## Constructors - -### constructor() - -> **new FraudPreventionV2Client**(`configurations`): [`FraudPreventionV2Client`](class.FraudPreventionV2Client.md) - -#### Parameters - -| Parameter | Type | -| :--------------- | :--------------------------------------------------------------------------------------- | -| `configurations` | [`ClientConfigurations`](../../models/core/interfaces/interface.ClientConfigurations.md) | - -#### Returns - -[`FraudPreventionV2Client`](class.FraudPreventionV2Client.md) - -#### Overrides - -Client.constructor - -#### Source - -client/apis/FraudPreventionV2Client.ts:54 - -## Methods - -### notifyWithAccountUpdate() - -> **notifyWithAccountUpdate**(`accountUpdateRequest`, `transactionId` = `...`): `Promise`\< [`AccountUpdateResponse`](../../models/classes/class.AccountUpdateResponse.md) \> - -Send an update as a result of an account screen transaction -The Account Update API is called when there is an account lifecycle transition such as a challenge outcome, account restoration, or remediation action completion. For example, if a user\'s account is disabled, deleted, or restored, the Account Update API is called to notify Expedia Group about the change. The Account Update API is also called when a user responds to a login Multi-Factor Authentication based on a Fraud recommendation. - -#### Throws - -ExpediaGroupApiAccountTakeoverBadRequestError - -#### Throws - -ExpediaGroupApiAccountTakeoverUnauthorizedError - -#### Throws - -ExpediaGroupApiForbiddenError - -#### Throws - -ExpediaGroupApiAccountUpdateNotFoundError - -#### Throws - -ExpediaGroupApiTooManyRequestsError - -#### Throws - -ExpediaGroupApiInternalServerError - -#### Throws - -ExpediaGroupApiBadGatewayError - -#### Throws - -ExpediaGroupApiServiceUnavailableError - -#### Throws - -ExpediaGroupApiGatewayTimeoutError - -#### Parameters - -| Parameter | Type | Description | -| :--------------------- | :--------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------- | -| `accountUpdateRequest` | [`AccountUpdateRequest`](../../models/classes/class.AccountUpdateRequest.md) | An AccountUpdate request may be of one of the following types `MULTI_FACTOR_AUTHENTICATION_UPDATE`, `REMEDIATION_UPDATE`. | -| `transactionId` | `string` | A unique ID to uniquely identify a request/response cycle (optional, defaults to a random generated UUID)\ | - -#### Returns - -`Promise`\< [`AccountUpdateResponse`](../../models/classes/class.AccountUpdateResponse.md) \> - -Promise - -#### Source - -client/apis/FraudPreventionV2Client.ts:86 - ---- - -### notifyWithOrderUpdate() - -> **notifyWithOrderUpdate**(`orderPurchaseUpdateRequest`, `transactionId` = `...`): `Promise`\< [`OrderPurchaseUpdateResponse`](../../models/classes/class.OrderPurchaseUpdateResponse.md) \> - -Send an update for a transaction -The Order Purchase Update API is called when the status of the order has changed. For example, if the customer cancels the reservation, changes reservation in any way, or adds additional products or travelers to the reservation, the Order Purchase Update API is called to notify Expedia Group about the change. The Order Purchase Update API is also called when the merchant cancels or changes an order based on a Fraud recommendation. - -#### Throws - -ExpediaGroupApiBadRequestError - -#### Throws - -ExpediaGroupApiUnauthorizedError - -#### Throws - -ExpediaGroupApiForbiddenError - -#### Throws - -ExpediaGroupApiOrderPurchaseUpdateNotFoundError - -#### Throws - -ExpediaGroupApiTooManyRequestsError - -#### Throws - -ExpediaGroupApiInternalServerError - -#### Throws - -ExpediaGroupApiBadGatewayError - -#### Throws - -ExpediaGroupApiRetryableOrderPurchaseUpdateFailure - -#### Throws - -ExpediaGroupApiGatewayTimeoutError - -#### Parameters - -| Parameter | Type | Description | -| :--------------------------- | :--------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `orderPurchaseUpdateRequest` | [`OrderPurchaseUpdateRequest`](../../models/classes/class.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` | A unique ID to uniquely identify a request/response cycle (optional, defaults to a random generated UUID)\ | - -#### Returns - -`Promise`\< [`OrderPurchaseUpdateResponse`](../../models/classes/class.OrderPurchaseUpdateResponse.md) \> - -Promise - -#### Source - -client/apis/FraudPreventionV2Client.ts:129 - ---- - -### screenAccount() - -> **screenAccount**(`accountScreenRequest`, `transactionId` = `...`): `Promise`\< [`AccountScreenResponse`](../../models/classes/class.AccountScreenResponse.md) \> - -Run fraud screening for one transaction -The Account Screen API gives a Fraud recommendation for an account transaction. A recommendation can be ACCEPT, CHALLENGE, or REJECT. A transaction is marked as CHALLENGE whenever there are insufficient signals to recommend ACCEPT or REJECT. These CHALLENGE incidents are manually reviewed, and a corrected recommendation is made asynchronously. - -#### Throws - -ExpediaGroupApiAccountTakeoverBadRequestError - -#### Throws - -ExpediaGroupApiAccountTakeoverUnauthorizedError - -#### Throws - -ExpediaGroupApiForbiddenError - -#### Throws - -ExpediaGroupApiNotFoundError - -#### Throws - -ExpediaGroupApiTooManyRequestsError - -#### Throws - -ExpediaGroupApiInternalServerError - -#### Throws - -ExpediaGroupApiBadGatewayError - -#### Throws - -ExpediaGroupApiServiceUnavailableError - -#### Throws - -ExpediaGroupApiGatewayTimeoutError - -#### Parameters - -| Parameter | Type | Description | -| :--------------------- | :--------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------- | -| `accountScreenRequest` | [`AccountScreenRequest`](../../models/classes/class.AccountScreenRequest.md) | | -| `transactionId` | `string` | A unique ID to uniquely identify a request/response cycle (optional, defaults to a random generated UUID)\ | - -#### Returns - -`Promise`\< [`AccountScreenResponse`](../../models/classes/class.AccountScreenResponse.md) \> - -Promise - -#### Source - -client/apis/FraudPreventionV2Client.ts:172 - ---- - -### screenOrder() - -> **screenOrder**(`orderPurchaseScreenRequest`, `transactionId` = `...`): `Promise`\< [`OrderPurchaseScreenResponse`](../../models/classes/class.OrderPurchaseScreenResponse.md) \> - -Run fraud screening for one transaction -The Order Purchase API gives a Fraud recommendation for a transaction. A recommendation can be Accept, Reject, or Review. A transaction is marked as Review whenever there are insufficient signals to recommend Accept or Reject. These incidents are manually reviewed, and a corrected recommendation is made asynchronously. - -#### Throws - -ExpediaGroupApiBadRequestError - -#### Throws - -ExpediaGroupApiUnauthorizedError - -#### Throws - -ExpediaGroupApiForbiddenError - -#### Throws - -ExpediaGroupApiNotFoundError - -#### Throws - -ExpediaGroupApiTooManyRequestsError - -#### Throws - -ExpediaGroupApiInternalServerError - -#### Throws - -ExpediaGroupApiBadGatewayError - -#### Throws - -ExpediaGroupApiRetryableOrderPurchaseScreenFailure - -#### Throws - -ExpediaGroupApiGatewayTimeoutError - -#### Parameters - -| Parameter | Type | Description | -| :--------------------------- | :--------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------- | -| `orderPurchaseScreenRequest` | [`OrderPurchaseScreenRequest`](../../models/classes/class.OrderPurchaseScreenRequest.md) | | -| `transactionId` | `string` | A unique ID to uniquely identify a request/response cycle (optional, defaults to a random generated UUID)\ | - -#### Returns - -`Promise`\< [`OrderPurchaseScreenResponse`](../../models/classes/class.OrderPurchaseScreenResponse.md) \> - -Promise - -#### Source - -client/apis/FraudPreventionV2Client.ts:212 diff --git a/release/fraudPreventionV2/docs/index.md b/release/fraudPreventionV2/docs/index.md deleted file mode 100644 index 5d8bae48..00000000 --- a/release/fraudPreventionV2/docs/index.md +++ /dev/null @@ -1,6 +0,0 @@ -# @expediagroup/fraudpreventionv2-sdk - -## Modules - -- [client](client/index.md) -- [models](models/index.md) diff --git a/release/fraudPreventionV2/docs/models/classes/class.AccountScreenRequest.md b/release/fraudPreventionV2/docs/models/classes/class.AccountScreenRequest.md deleted file mode 100644 index 15274c83..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.AccountScreenRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountScreenRequest - -# Class: AccountScreenRequest - -Information for account screening by Expedia\'s Fraud Prevention Service. - -## Constructors - -### constructor() - -> **new AccountScreenRequest**(`accountScreenRequest`): [`AccountScreenRequest`](class.AccountScreenRequest.md) - -#### Parameters - -| Parameter | Type | -| :--------------------- | :-------------------------------------------------------------------------------------------- | -| `accountScreenRequest` | [`AccountScreenRequestProperties`](../interfaces/interface.AccountScreenRequestProperties.md) | - -#### Returns - -[`AccountScreenRequest`](class.AccountScreenRequest.md) - -#### Source - -models/AccountScreenRequest.ts:36 - -## Properties - -| Property | Type | -| :------------ | :-------------------------------------------------- | -| `transaction` | [`AccountTransaction`](class.AccountTransaction.md) | diff --git a/release/fraudPreventionV2/docs/models/classes/class.AccountScreenResponse.md b/release/fraudPreventionV2/docs/models/classes/class.AccountScreenResponse.md deleted file mode 100644 index 8f0d04d3..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.AccountScreenResponse.md +++ /dev/null @@ -1,32 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountScreenResponse - -# Class: AccountScreenResponse - -Response for an account transaction provided by Expedia\'s Fraud Prevention Service. - -## Constructors - -### constructor() - -> **new AccountScreenResponse**(`accountScreenResponse`): [`AccountScreenResponse`](class.AccountScreenResponse.md) - -#### Parameters - -| Parameter | Type | -| :---------------------- | :---------------------------------------------------------------------------------------------- | -| `accountScreenResponse` | [`AccountScreenResponseProperties`](../interfaces/interface.AccountScreenResponseProperties.md) | - -#### Returns - -[`AccountScreenResponse`](class.AccountScreenResponse.md) - -#### Source - -models/AccountScreenResponse.ts:37 - -## Properties - -| Property | Type | Description | -| :---------- | :------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------ | -| `decision`? | [`AccountTakeoverFraudDecision`](../type-aliases/type-alias.AccountTakeoverFraudDecision.md) | - | -| `riskId`? | `string` | Unique identifier assigned to the transaction by Expedia\'s Fraud Prevention Service. | diff --git a/release/fraudPreventionV2/docs/models/classes/class.AccountTakeoverBadRequestError.md b/release/fraudPreventionV2/docs/models/classes/class.AccountTakeoverBadRequestError.md deleted file mode 100644 index 977df605..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.AccountTakeoverBadRequestError.md +++ /dev/null @@ -1,33 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountTakeoverBadRequestError - -# Class: AccountTakeoverBadRequestError - -Indicates that a bad request occurred. Typically it is an invalid parameter. - -## Constructors - -### constructor() - -> **new AccountTakeoverBadRequestError**(`accountTakeoverBadRequestError`): [`AccountTakeoverBadRequestError`](class.AccountTakeoverBadRequestError.md) - -#### Parameters - -| Parameter | Type | -| :------------------------------- | :---------------------------------------------------------------------------------------------------------------- | -| `accountTakeoverBadRequestError` | [`AccountTakeoverBadRequestErrorProperties`](../interfaces/interface.AccountTakeoverBadRequestErrorProperties.md) | - -#### Returns - -[`AccountTakeoverBadRequestError`](class.AccountTakeoverBadRequestError.md) - -#### Source - -models/AccountTakeoverBadRequestError.ts:48 - -## Properties - -| Property | Type | Description | -| :-------- | :--------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------- | -| `causes`? | [`AccountTakeoverBadRequestErrorAllOfCauses`](class.AccountTakeoverBadRequestErrorAllOfCauses.md)[] | - | -| `code` | [`AccountTakeoverBadRequestErrorCodeEnum`](../type-aliases/type-alias.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/class.AccountTakeoverBadRequestErrorAllOfCauses.md b/release/fraudPreventionV2/docs/models/classes/class.AccountTakeoverBadRequestErrorAllOfCauses.md deleted file mode 100644 index e0c78087..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.AccountTakeoverBadRequestErrorAllOfCauses.md +++ /dev/null @@ -1,31 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountTakeoverBadRequestErrorAllOfCauses - -# Class: AccountTakeoverBadRequestErrorAllOfCauses - -## Constructors - -### constructor() - -> **new AccountTakeoverBadRequestErrorAllOfCauses**(`accountTakeoverBadRequestErrorAllOfCauses`): [`AccountTakeoverBadRequestErrorAllOfCauses`](class.AccountTakeoverBadRequestErrorAllOfCauses.md) - -#### Parameters - -| Parameter | Type | -| :------------------------------------------ | :-------------------------------------------------------------------------------------------------------------------------------------- | -| `accountTakeoverBadRequestErrorAllOfCauses` | [`AccountTakeoverBadRequestErrorAllOfCausesProperties`](../interfaces/interface.AccountTakeoverBadRequestErrorAllOfCausesProperties.md) | - -#### Returns - -[`AccountTakeoverBadRequestErrorAllOfCauses`](class.AccountTakeoverBadRequestErrorAllOfCauses.md) - -#### Source - -models/AccountTakeoverBadRequestErrorAllOfCauses.ts:35 - -## Properties - -| Property | Type | Description | -| :--------- | :------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------ | -| `code`? | [`AccountTakeoverBadRequestErrorAllOfCausesCodeEnum`](../type-aliases/type-alias.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/class.AccountTakeoverCustomerAccount.md b/release/fraudPreventionV2/docs/models/classes/class.AccountTakeoverCustomerAccount.md deleted file mode 100644 index 90fdc839..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.AccountTakeoverCustomerAccount.md +++ /dev/null @@ -1,41 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountTakeoverCustomerAccount - -# Class: AccountTakeoverCustomerAccount - -Information about a user\'s account. - -## Constructors - -### constructor() - -> **new AccountTakeoverCustomerAccount**(`accountTakeoverCustomerAccount`): [`AccountTakeoverCustomerAccount`](class.AccountTakeoverCustomerAccount.md) - -#### Parameters - -| Parameter | Type | -| :------------------------------- | :---------------------------------------------------------------------------------------------------------------- | -| `accountTakeoverCustomerAccount` | [`AccountTakeoverCustomerAccountProperties`](../interfaces/interface.AccountTakeoverCustomerAccountProperties.md) | - -#### Returns - -[`AccountTakeoverCustomerAccount`](class.AccountTakeoverCustomerAccount.md) - -#### Source - -models/AccountTakeoverCustomerAccount.ts:93 - -## Properties - -| Property | Type | Description | -| :----------------- | :----------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `accountRole`? | [`AccountTakeoverCustomerAccountAccountRoleEnum`](../type-aliases/type-alias.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/type-alias.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`](class.CustomerAccountAddress.md) | - | -| `emailAddress` | `string` | Email address for the account owner. | -| `loyaltyMemberId`? | `string` | Unique loyalty identifier for a user. | -| `name`? | [`AccountTakeoverName`](class.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`](class.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/class.AccountTakeoverDeviceDetails.md b/release/fraudPreventionV2/docs/models/classes/class.AccountTakeoverDeviceDetails.md deleted file mode 100644 index 1dcb1c1a..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.AccountTakeoverDeviceDetails.md +++ /dev/null @@ -1,35 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountTakeoverDeviceDetails - -# Class: AccountTakeoverDeviceDetails - -Information specific to the Partner\'s device through which a transaction was made. - -## Constructors - -### constructor() - -> **new AccountTakeoverDeviceDetails**(`accountTakeoverDeviceDetails`): [`AccountTakeoverDeviceDetails`](class.AccountTakeoverDeviceDetails.md) - -#### Parameters - -| Parameter | Type | -| :----------------------------- | :------------------------------------------------------------------------------------------------------------ | -| `accountTakeoverDeviceDetails` | [`AccountTakeoverDeviceDetailsProperties`](../interfaces/interface.AccountTakeoverDeviceDetailsProperties.md) | - -#### Returns - -[`AccountTakeoverDeviceDetails`](class.AccountTakeoverDeviceDetails.md) - -#### Source - -models/AccountTakeoverDeviceDetails.ts:54 - -## Properties - -| 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/type-alias.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/class.AccountTakeoverError.md b/release/fraudPreventionV2/docs/models/classes/class.AccountTakeoverError.md deleted file mode 100644 index 50173c5f..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.AccountTakeoverError.md +++ /dev/null @@ -1,32 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountTakeoverError - -# Class: AccountTakeoverError - -The object used to describe an error, containing both human-readable and machine-readable information. - -## Constructors - -### constructor() - -> **new AccountTakeoverError**(`accountTakeoverError`): [`AccountTakeoverError`](class.AccountTakeoverError.md) - -#### Parameters - -| Parameter | Type | -| :--------------------- | :-------------------------------------------------------------------------------------------- | -| `accountTakeoverError` | [`AccountTakeoverErrorProperties`](../interfaces/interface.AccountTakeoverErrorProperties.md) | - -#### Returns - -[`AccountTakeoverError`](class.AccountTakeoverError.md) - -#### Source - -models/AccountTakeoverError.ts:39 - -## Properties - -| Property | Type | Description | -| :-------- | :------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------- | -| `code` | [`AccountTakeoverErrorCodeEnum`](../type-aliases/type-alias.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/class.AccountTakeoverName.md b/release/fraudPreventionV2/docs/models/classes/class.AccountTakeoverName.md deleted file mode 100644 index 6ccedc28..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.AccountTakeoverName.md +++ /dev/null @@ -1,35 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountTakeoverName - -# Class: AccountTakeoverName - -Group of attributes intended to hold information about a customer or traveler\'\'s name for the account. - -## Constructors - -### constructor() - -> **new AccountTakeoverName**(`accountTakeoverName`): [`AccountTakeoverName`](class.AccountTakeoverName.md) - -#### Parameters - -| Parameter | Type | -| :-------------------- | :------------------------------------------------------------------------------------------ | -| `accountTakeoverName` | [`AccountTakeoverNameProperties`](../interfaces/interface.AccountTakeoverNameProperties.md) | - -#### Returns - -[`AccountTakeoverName`](class.AccountTakeoverName.md) - -#### Source - -models/AccountTakeoverName.ts:54 - -## Properties - -| 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/class.AccountTakeoverSiteInfo.md b/release/fraudPreventionV2/docs/models/classes/class.AccountTakeoverSiteInfo.md deleted file mode 100644 index 03fc7a5c..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.AccountTakeoverSiteInfo.md +++ /dev/null @@ -1,34 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountTakeoverSiteInfo - -# Class: AccountTakeoverSiteInfo - -Information specific to the Partner\'s website through which a transaction was made. - -## Constructors - -### constructor() - -> **new AccountTakeoverSiteInfo**(`accountTakeoverSiteInfo`): [`AccountTakeoverSiteInfo`](class.AccountTakeoverSiteInfo.md) - -#### Parameters - -| Parameter | Type | -| :------------------------ | :-------------------------------------------------------------------------------------------------- | -| `accountTakeoverSiteInfo` | [`AccountTakeoverSiteInfoProperties`](../interfaces/interface.AccountTakeoverSiteInfoProperties.md) | - -#### Returns - -[`AccountTakeoverSiteInfo`](class.AccountTakeoverSiteInfo.md) - -#### Source - -models/AccountTakeoverSiteInfo.ts:49 - -## Properties - -| 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/type-alias.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/class.AccountTakeoverTransactionDetails.md b/release/fraudPreventionV2/docs/models/classes/class.AccountTakeoverTransactionDetails.md deleted file mode 100644 index 43054f73..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.AccountTakeoverTransactionDetails.md +++ /dev/null @@ -1,37 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountTakeoverTransactionDetails - -# Class: AccountTakeoverTransactionDetails - -The `transaction_type` field value is used as a discriminator, with the following mapping: \* `LOGIN`: `LoginTransactionDetails` - -## Extended By - -- [`LoginTransactionDetails`](class.LoginTransactionDetails.md) - -## Constructors - -### constructor() - -> **new AccountTakeoverTransactionDetails**(`accountTakeoverTransactionDetails`): [`AccountTakeoverTransactionDetails`](class.AccountTakeoverTransactionDetails.md) - -#### Parameters - -| Parameter | Type | -| :---------------------------------- | :---------------------------------------------------------------------------------------------------------------------- | -| `accountTakeoverTransactionDetails` | [`AccountTakeoverTransactionDetailsProperties`](../interfaces/interface.AccountTakeoverTransactionDetailsProperties.md) | - -#### Returns - -[`AccountTakeoverTransactionDetails`](class.AccountTakeoverTransactionDetails.md) - -#### Source - -models/AccountTakeoverTransactionDetails.ts:47 - -## Properties - -| Property | Type | Description | -| :-------------------- | :-------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------- | -| `currentUserSession`? | [`CurrentUserSession`](class.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/class.AccountTakeoverUnauthorizedError.md b/release/fraudPreventionV2/docs/models/classes/class.AccountTakeoverUnauthorizedError.md deleted file mode 100644 index 8a6ce95d..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.AccountTakeoverUnauthorizedError.md +++ /dev/null @@ -1,32 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountTakeoverUnauthorizedError - -# Class: AccountTakeoverUnauthorizedError - -Indicates that the token sent in the \'Authorization\' header is either invalid or missing. Please check the value in the token field along with the token expiration time before retrying. - -## Constructors - -### constructor() - -> **new AccountTakeoverUnauthorizedError**(`accountTakeoverUnauthorizedError`): [`AccountTakeoverUnauthorizedError`](class.AccountTakeoverUnauthorizedError.md) - -#### Parameters - -| Parameter | Type | -| :--------------------------------- | :-------------------------------------------------------------------------------------------------------------------- | -| `accountTakeoverUnauthorizedError` | [`AccountTakeoverUnauthorizedErrorProperties`](../interfaces/interface.AccountTakeoverUnauthorizedErrorProperties.md) | - -#### Returns - -[`AccountTakeoverUnauthorizedError`](class.AccountTakeoverUnauthorizedError.md) - -#### Source - -models/AccountTakeoverUnauthorizedError.ts:39 - -## Properties - -| Property | Type | Description | -| :-------- | :------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------- | -| `code` | [`AccountTakeoverUnauthorizedErrorCodeEnum`](../type-aliases/type-alias.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/class.AccountTransaction.md b/release/fraudPreventionV2/docs/models/classes/class.AccountTransaction.md deleted file mode 100644 index 12218388..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.AccountTransaction.md +++ /dev/null @@ -1,34 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountTransaction - -# Class: AccountTransaction - -Information for an account transaction. - -## Constructors - -### constructor() - -> **new AccountTransaction**(`accountTransaction`): [`AccountTransaction`](class.AccountTransaction.md) - -#### Parameters - -| Parameter | Type | -| :------------------- | :---------------------------------------------------------------------------------------- | -| `accountTransaction` | [`AccountTransactionProperties`](../interfaces/interface.AccountTransactionProperties.md) | - -#### Returns - -[`AccountTransaction`](class.AccountTransaction.md) - -#### Source - -models/AccountTransaction.ts:63 - -## Properties - -| Property | Type | -| :------------------- | :-------------------------------------------------------------------------------- | -| `customerAccount` | [`AccountTakeoverCustomerAccount`](class.AccountTakeoverCustomerAccount.md) | -| `deviceDetails` | [`AccountTakeoverDeviceDetails`](class.AccountTakeoverDeviceDetails.md) | -| `siteInfo` | [`AccountTakeoverSiteInfo`](class.AccountTakeoverSiteInfo.md) | -| `transactionDetails` | [`AccountTakeoverTransactionDetails`](class.AccountTakeoverTransactionDetails.md) | diff --git a/release/fraudPreventionV2/docs/models/classes/class.AccountUpdateNotFoundError.md b/release/fraudPreventionV2/docs/models/classes/class.AccountUpdateNotFoundError.md deleted file mode 100644 index 9dd0729c..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.AccountUpdateNotFoundError.md +++ /dev/null @@ -1,32 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountUpdateNotFoundError - -# Class: AccountUpdateNotFoundError - -Indicates that the API cannot find the resource that is either being requested or against which the operation is being performed. - -## Constructors - -### constructor() - -> **new AccountUpdateNotFoundError**(`accountUpdateNotFoundError`): [`AccountUpdateNotFoundError`](class.AccountUpdateNotFoundError.md) - -#### Parameters - -| Parameter | Type | -| :--------------------------- | :-------------------------------------------------------------------------------------------------------- | -| `accountUpdateNotFoundError` | [`AccountUpdateNotFoundErrorProperties`](../interfaces/interface.AccountUpdateNotFoundErrorProperties.md) | - -#### Returns - -[`AccountUpdateNotFoundError`](class.AccountUpdateNotFoundError.md) - -#### Source - -models/AccountUpdateNotFoundError.ts:39 - -## Properties - -| Property | Type | Description | -| :-------- | :------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------- | -| `code` | [`AccountUpdateNotFoundErrorCodeEnum`](../type-aliases/type-alias.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/class.AccountUpdateRequest.md b/release/fraudPreventionV2/docs/models/classes/class.AccountUpdateRequest.md deleted file mode 100644 index 08bd9c48..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.AccountUpdateRequest.md +++ /dev/null @@ -1,36 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountUpdateRequest - -# Class: AccountUpdateRequest - -The `type` field value is used as a discriminator, with the following mapping: _ `MULTI_FACTOR_AUTHENTICATION_UPDATE`: `MultiFactorAuthenticationUpdate` _ `REMEDIATION_UPDATE`: `RemediationUpdate` - -## Extended By - -- [`MultiFactorAuthenticationUpdate`](class.MultiFactorAuthenticationUpdate.md) -- [`RemediationUpdate`](class.RemediationUpdate.md) - -## Constructors - -### constructor() - -> **new AccountUpdateRequest**(`accountUpdateRequest`): [`AccountUpdateRequest`](class.AccountUpdateRequest.md) - -#### Parameters - -| Parameter | Type | -| :--------------------- | :-------------------------------------------------------------------------------------------- | -| `accountUpdateRequest` | [`AccountUpdateRequestProperties`](../interfaces/interface.AccountUpdateRequestProperties.md) | - -#### Returns - -[`AccountUpdateRequest`](class.AccountUpdateRequest.md) - -#### Source - -models/AccountUpdateRequest.ts:34 - -## Properties - -| 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/class.AccountUpdateResponse.md b/release/fraudPreventionV2/docs/models/classes/class.AccountUpdateResponse.md deleted file mode 100644 index 47bad096..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.AccountUpdateResponse.md +++ /dev/null @@ -1,29 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountUpdateResponse - -# Class: AccountUpdateResponse - -## Constructors - -### constructor() - -> **new AccountUpdateResponse**(`accountUpdateResponse`): [`AccountUpdateResponse`](class.AccountUpdateResponse.md) - -#### Parameters - -| Parameter | Type | -| :---------------------- | :---------------------------------------------------------------------------------------------- | -| `accountUpdateResponse` | [`AccountUpdateResponseProperties`](../interfaces/interface.AccountUpdateResponseProperties.md) | - -#### Returns - -[`AccountUpdateResponse`](class.AccountUpdateResponse.md) - -#### Source - -models/AccountUpdateResponse.ts:31 - -## Properties - -| Property | Type | Description | -| :-------- | :------- | :------------------------------------------------- | -| `riskId`? | `string` | Unique identifier of transaction that was updated. | diff --git a/release/fraudPreventionV2/docs/models/classes/class.Address.md b/release/fraudPreventionV2/docs/models/classes/class.Address.md deleted file mode 100644 index 3be6ae6e..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.Address.md +++ /dev/null @@ -1,35 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > Address - -# Class: Address - -## Constructors - -### constructor() - -> **new Address**(`address`): [`Address`](class.Address.md) - -#### Parameters - -| Parameter | Type | -| :-------- | :------------------------------------------------------------------ | -| `address` | [`AddressProperties`](../interfaces/interface.AddressProperties.md) | - -#### Returns - -[`Address`](class.Address.md) - -#### Source - -models/Address.ts:58 - -## Properties - -| 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/type-alias.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/class.Air.md b/release/fraudPreventionV2/docs/models/classes/class.Air.md deleted file mode 100644 index 43bb94ff..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.Air.md +++ /dev/null @@ -1,50 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > Air - -# Class: Air - -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` - -## Extends - -- [`TravelProduct`](class.TravelProduct.md) - -## Constructors - -### constructor() - -> **new Air**(`air`): [`Air`](class.Air.md) - -#### Parameters - -| Parameter | Type | -| :-------- | :---------------------------------------------------------- | -| `air` | [`AirProperties`](../interfaces/interface.AirProperties.md) | - -#### Returns - -[`Air`](class.Air.md) - -#### Overrides - -[`TravelProduct`](class.TravelProduct.md).[`constructor`](class.TravelProduct.md#constructor) - -#### Source - -models/Air.ts:67 - -## Properties - -| Property | Type | Description | -| :------------------------------ | :--------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `airSegments` | [`AirSegment`](class.AirSegment.md)[] | Additional airline and flight details for each of the trip segments. | -| `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`. | -| `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`. | -| `flightType`? | [`AirFlightTypeEnum`](../type-aliases/type-alias.AirFlightTypeEnum.md) | Identifies the type of air trip based on the air destinations. | -| `globalDistributionSystemType`? | `string` | Associated with Passenger Name Record (PNR). | -| `inventorySource` | [`TravelProductInventorySourceEnum`](../type-aliases/type-alias.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` | -| `passengerNameRecord`? | `string` | Airline booking confirmation code for the trip. | -| `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`](class.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. | -| `readonly` `type` | `"AIR"` | - | diff --git a/release/fraudPreventionV2/docs/models/classes/class.AirSegment.md b/release/fraudPreventionV2/docs/models/classes/class.AirSegment.md deleted file mode 100644 index 051730c1..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.AirSegment.md +++ /dev/null @@ -1,33 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AirSegment - -# Class: AirSegment - -## Constructors - -### constructor() - -> **new AirSegment**(`airSegment`): [`AirSegment`](class.AirSegment.md) - -#### Parameters - -| Parameter | Type | -| :----------- | :------------------------------------------------------------------------ | -| `airSegment` | [`AirSegmentProperties`](../interfaces/interface.AirSegmentProperties.md) | - -#### Returns - -[`AirSegment`](class.AirSegment.md) - -#### Source - -models/AirSegment.ts:51 - -## Properties - -| 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/class.Amount.md b/release/fraudPreventionV2/docs/models/classes/class.Amount.md deleted file mode 100644 index 41f1817a..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.Amount.md +++ /dev/null @@ -1,30 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > Amount - -# Class: Amount - -## Constructors - -### constructor() - -> **new Amount**(`amount`): [`Amount`](class.Amount.md) - -#### Parameters - -| Parameter | Type | -| :-------- | :---------------------------------------------------------------- | -| `amount` | [`AmountProperties`](../interfaces/interface.AmountProperties.md) | - -#### Returns - -[`Amount`](class.Amount.md) - -#### Source - -models/Amount.ts:36 - -## Properties - -| 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/class.Authorize.md b/release/fraudPreventionV2/docs/models/classes/class.Authorize.md deleted file mode 100644 index e524adb2..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.Authorize.md +++ /dev/null @@ -1,33 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > Authorize - -# Class: Authorize - -Authorize operation on the payment. An authorize operation represents placing the funds on hold with the specified form of payment. - -## Constructors - -### constructor() - -> **new Authorize**(`authorize`): [`Authorize`](class.Authorize.md) - -#### Parameters - -| Parameter | Type | -| :---------- | :---------------------------------------------------------------------- | -| `authorize` | [`AuthorizeProperties`](../interfaces/interface.AuthorizeProperties.md) | - -#### Returns - -[`Authorize`](class.Authorize.md) - -#### Source - -models/Authorize.ts:47 - -## Properties - -| Property | Type | -| :--------- | :------------------------------------------ | -| `amount`? | [`Amount`](class.Amount.md) | -| `id`? | `string` | -| `outcome`? | [`PaymentOutcome`](class.PaymentOutcome.md) | diff --git a/release/fraudPreventionV2/docs/models/classes/class.AuthorizeReversal.md b/release/fraudPreventionV2/docs/models/classes/class.AuthorizeReversal.md deleted file mode 100644 index ccd21f9a..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.AuthorizeReversal.md +++ /dev/null @@ -1,33 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AuthorizeReversal - -# Class: AuthorizeReversal - -Authorize Reversal operation on the payment. An authorize reversal operation represents a notification received usually from a 3rd party payment processor to indicate that an authorization hold should be released as a result of a sale being partially or completely cancelled. - -## Constructors - -### constructor() - -> **new AuthorizeReversal**(`authorizeReversal`): [`AuthorizeReversal`](class.AuthorizeReversal.md) - -#### Parameters - -| Parameter | Type | -| :------------------ | :-------------------------------------------------------------------------------------- | -| `authorizeReversal` | [`AuthorizeReversalProperties`](../interfaces/interface.AuthorizeReversalProperties.md) | - -#### Returns - -[`AuthorizeReversal`](class.AuthorizeReversal.md) - -#### Source - -models/AuthorizeReversal.ts:47 - -## Properties - -| Property | Type | -| :--------- | :------------------------------------------ | -| `amount`? | [`Amount`](class.Amount.md) | -| `id`? | `string` | -| `outcome`? | [`PaymentOutcome`](class.PaymentOutcome.md) | diff --git a/release/fraudPreventionV2/docs/models/classes/class.BadGatewayError.md b/release/fraudPreventionV2/docs/models/classes/class.BadGatewayError.md deleted file mode 100644 index a438c530..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.BadGatewayError.md +++ /dev/null @@ -1,32 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > BadGatewayError - -# Class: BadGatewayError - -Indicates that the server received an invalid response from the upstream server. Causes could be incorrectly configured target server at gateway, EOF exception, incorrectly configured keep-alive timeouts. Please reach out to support team as next step for this error resolution. - -## Constructors - -### constructor() - -> **new BadGatewayError**(`badGatewayError`): [`BadGatewayError`](class.BadGatewayError.md) - -#### Parameters - -| Parameter | Type | -| :---------------- | :---------------------------------------------------------------------------------- | -| `badGatewayError` | [`BadGatewayErrorProperties`](../interfaces/interface.BadGatewayErrorProperties.md) | - -#### Returns - -[`BadGatewayError`](class.BadGatewayError.md) - -#### Source - -models/BadGatewayError.ts:39 - -## Properties - -| Property | Type | Description | -| :-------- | :--------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------- | -| `code` | [`BadGatewayErrorCodeEnum`](../type-aliases/type-alias.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/class.BadRequestError.md b/release/fraudPreventionV2/docs/models/classes/class.BadRequestError.md deleted file mode 100644 index cf8080ac..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.BadRequestError.md +++ /dev/null @@ -1,33 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > BadRequestError - -# Class: BadRequestError - -Indicates that a bad request occurred. Typically it is an invalid parameter. - -## Constructors - -### constructor() - -> **new BadRequestError**(`badRequestError`): [`BadRequestError`](class.BadRequestError.md) - -#### Parameters - -| Parameter | Type | -| :---------------- | :---------------------------------------------------------------------------------- | -| `badRequestError` | [`BadRequestErrorProperties`](../interfaces/interface.BadRequestErrorProperties.md) | - -#### Returns - -[`BadRequestError`](class.BadRequestError.md) - -#### Source - -models/BadRequestError.ts:47 - -## Properties - -| Property | Type | Description | -| :-------- | :--------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------- | -| `causes`? | [`BadRequestErrorAllOfCauses`](class.BadRequestErrorAllOfCauses.md)[] | - | -| `code` | [`BadRequestErrorCodeEnum`](../type-aliases/type-alias.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/class.BadRequestErrorAllOfCauses.md b/release/fraudPreventionV2/docs/models/classes/class.BadRequestErrorAllOfCauses.md deleted file mode 100644 index 69f41dd4..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.BadRequestErrorAllOfCauses.md +++ /dev/null @@ -1,31 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > BadRequestErrorAllOfCauses - -# Class: BadRequestErrorAllOfCauses - -## Constructors - -### constructor() - -> **new BadRequestErrorAllOfCauses**(`badRequestErrorAllOfCauses`): [`BadRequestErrorAllOfCauses`](class.BadRequestErrorAllOfCauses.md) - -#### Parameters - -| Parameter | Type | -| :--------------------------- | :-------------------------------------------------------------------------------------------------------- | -| `badRequestErrorAllOfCauses` | [`BadRequestErrorAllOfCausesProperties`](../interfaces/interface.BadRequestErrorAllOfCausesProperties.md) | - -#### Returns - -[`BadRequestErrorAllOfCauses`](class.BadRequestErrorAllOfCauses.md) - -#### Source - -models/BadRequestErrorAllOfCauses.ts:35 - -## Properties - -| Property | Type | Description | -| :--------- | :------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------ | -| `code`? | [`BadRequestErrorAllOfCausesCodeEnum`](../type-aliases/type-alias.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/class.CancellationReason.md b/release/fraudPreventionV2/docs/models/classes/class.CancellationReason.md deleted file mode 100644 index 4f86bc90..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.CancellationReason.md +++ /dev/null @@ -1,34 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > CancellationReason - -# Class: CancellationReason - -Reason of order update cancellation. - -## Constructors - -### constructor() - -> **new CancellationReason**(`cancellationReason`): [`CancellationReason`](class.CancellationReason.md) - -#### Parameters - -| Parameter | Type | -| :------------------- | :---------------------------------------------------------------------------------------- | -| `cancellationReason` | [`CancellationReasonProperties`](../interfaces/interface.CancellationReasonProperties.md) | - -#### Returns - -[`CancellationReason`](class.CancellationReason.md) - -#### Source - -models/CancellationReason.ts:49 - -## Properties - -| 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/class.Capture.md b/release/fraudPreventionV2/docs/models/classes/class.Capture.md deleted file mode 100644 index a231b957..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.Capture.md +++ /dev/null @@ -1,33 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > Capture - -# Class: Capture - -Capture operation on the payment. A capture operation represents a notification received usually from a 3rd party payment processor to indicate that the funds placed on hold will be captured and the funds transfer process will occur from the customer\'s funds to the merchant\'s funds. - -## Constructors - -### constructor() - -> **new Capture**(`capture`): [`Capture`](class.Capture.md) - -#### Parameters - -| Parameter | Type | -| :-------- | :------------------------------------------------------------------ | -| `capture` | [`CaptureProperties`](../interfaces/interface.CaptureProperties.md) | - -#### Returns - -[`Capture`](class.Capture.md) - -#### Source - -models/Capture.ts:47 - -## Properties - -| Property | Type | -| :--------- | :------------------------------------------ | -| `amount`? | [`Amount`](class.Amount.md) | -| `id`? | `string` | -| `outcome`? | [`PaymentOutcome`](class.PaymentOutcome.md) | diff --git a/release/fraudPreventionV2/docs/models/classes/class.Car.md b/release/fraudPreventionV2/docs/models/classes/class.Car.md deleted file mode 100644 index 3110c5ed..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.Car.md +++ /dev/null @@ -1,48 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > Car - -# Class: Car - -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` - -## Extends - -- [`TravelProduct`](class.TravelProduct.md) - -## Constructors - -### constructor() - -> **new Car**(`car`): [`Car`](class.Car.md) - -#### Parameters - -| Parameter | Type | -| :-------- | :---------------------------------------------------------- | -| `car` | [`CarProperties`](../interfaces/interface.CarProperties.md) | - -#### Returns - -[`Car`](class.Car.md) - -#### Overrides - -[`TravelProduct`](class.TravelProduct.md).[`constructor`](class.TravelProduct.md#constructor) - -#### Source - -models/Car.ts:51 - -## Properties - -| Property | Type | Description | -| :--------------------- | :--------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `dropOffLocation` | `string` | Location at which the automobile will be returned. | -| `inventorySource` | [`TravelProductInventorySourceEnum`](../type-aliases/type-alias.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. | -| `pickUpLocation` | `string` | Location where the automobile will be picked up. | -| `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`. | -| `price` | [`Amount`](class.Amount.md) | - | -| `returnTime` | `Date` | Local date and time the automobile will be returned, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | -| `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. | -| `readonly` `type` | `"CAR"` | - | diff --git a/release/fraudPreventionV2/docs/models/classes/class.ChallengeDetail.md b/release/fraudPreventionV2/docs/models/classes/class.ChallengeDetail.md deleted file mode 100644 index 9c2135bd..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.ChallengeDetail.md +++ /dev/null @@ -1,33 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > ChallengeDetail - -# Class: ChallengeDetail - -Information related to challenges initiated by the Partner\'s system to a user before calling Expedia\'s Fraud Prevention Service. - -## Constructors - -### constructor() - -> **new ChallengeDetail**(`challengeDetail`): [`ChallengeDetail`](class.ChallengeDetail.md) - -#### Parameters - -| Parameter | Type | -| :---------------- | :---------------------------------------------------------------------------------- | -| `challengeDetail` | [`ChallengeDetailProperties`](../interfaces/interface.ChallengeDetailProperties.md) | - -#### Returns - -[`ChallengeDetail`](class.ChallengeDetail.md) - -#### Source - -models/ChallengeDetail.ts:44 - -## Properties - -| 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/type-alias.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/type-alias.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/class.ChargebackDetail.md b/release/fraudPreventionV2/docs/models/classes/class.ChargebackDetail.md deleted file mode 100644 index 0ce8ea9c..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.ChargebackDetail.md +++ /dev/null @@ -1,35 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > ChargebackDetail - -# Class: ChargebackDetail - -Details related to the chargeback. - -## Constructors - -### constructor() - -> **new ChargebackDetail**(`chargebackDetail`): [`ChargebackDetail`](class.ChargebackDetail.md) - -#### Parameters - -| Parameter | Type | -| :----------------- | :------------------------------------------------------------------------------------ | -| `chargebackDetail` | [`ChargebackDetailProperties`](../interfaces/interface.ChargebackDetailProperties.md) | - -#### Returns - -[`ChargebackDetail`](class.ChargebackDetail.md) - -#### Source - -models/ChargebackDetail.ts:57 - -## Properties - -| Property | Type | Description | -| :---------------------------- | :----------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------- | -| `bankReasonCode`? | `string` | Unique code provided by the acquiring bank for the category of fraud. | -| `chargebackAmount` | [`Amount`](class.Amount.md) | - | -| `chargebackReason` | [`ChargebackDetailChargebackReasonEnum`](../type-aliases/type-alias.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/type-alias.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/class.ChargebackFeedback.md b/release/fraudPreventionV2/docs/models/classes/class.ChargebackFeedback.md deleted file mode 100644 index 02b7c512..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.ChargebackFeedback.md +++ /dev/null @@ -1,41 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > ChargebackFeedback - -# Class: ChargebackFeedback - -Feedback from EG external partners if they receive a chargeback for a false negative recommendation from Fraud Prevention system. - -## Extends - -- [`OrderPurchaseUpdateRequest`](class.OrderPurchaseUpdateRequest.md) - -## Constructors - -### constructor() - -> **new ChargebackFeedback**(`chargebackFeedback`): [`ChargebackFeedback`](class.ChargebackFeedback.md) - -#### Parameters - -| Parameter | Type | -| :------------------- | :---------------------------------------------------------------------------------------- | -| `chargebackFeedback` | [`ChargebackFeedbackProperties`](../interfaces/interface.ChargebackFeedbackProperties.md) | - -#### Returns - -[`ChargebackFeedback`](class.ChargebackFeedback.md) - -#### Overrides - -[`OrderPurchaseUpdateRequest`](class.OrderPurchaseUpdateRequest.md).[`constructor`](class.OrderPurchaseUpdateRequest.md#constructor) - -#### Source - -models/ChargebackFeedback.ts:41 - -## Properties - -| Property | Type | Description | -| :------------------ | :---------------------------------------------- | :-------------------------------------------------------------------------------------------------- | -| `chargebackDetail`? | [`ChargebackDetail`](class.ChargebackDetail.md) | - | -| `riskId` | `string` | The `risk_id` provided by Expedia\'s Fraud Prevention Service in the `OrderPurchaseScreenResponse`. | -| `readonly` `type` | `"CHARGEBACK_FEEDBACK"` | - | diff --git a/release/fraudPreventionV2/docs/models/classes/class.CreditCard.md b/release/fraudPreventionV2/docs/models/classes/class.CreditCard.md deleted file mode 100644 index 8fd37fcc..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.CreditCard.md +++ /dev/null @@ -1,59 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > CreditCard - -# Class: CreditCard - -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` - -## Extends - -- [`Payment`](class.Payment.md) - -## Constructors - -### constructor() - -> **new CreditCard**(`creditCard`): [`CreditCard`](class.CreditCard.md) - -#### Parameters - -| Parameter | Type | -| :----------- | :------------------------------------------------------------------------ | -| `creditCard` | [`CreditCardProperties`](../interfaces/interface.CreditCardProperties.md) | - -#### Returns - -[`CreditCard`](class.CreditCard.md) - -#### Overrides - -[`Payment`](class.Payment.md).[`constructor`](class.Payment.md#constructor) - -#### Source - -models/CreditCard.ts:92 - -## Properties - -| Property | Type | Description | -| :-------------------------------- | :------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `authorizedAmount`? | [`Amount`](class.Amount.md) | - | -| `billingAddress` | [`PaymentBillingAddress`](class.PaymentBillingAddress.md) | - | -| `billingEmailAddress` | `string` | Email address associated with the payment. | -| `billingName` | [`Name`](class.Name.md) | - | -| `brand` | [`PaymentBrandEnum`](../type-aliases/type-alias.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` _ `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` | -| `cardAuthenticationFailureCount`? | `number` | Total authentication failure count for given card. | -| `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. | -| `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. | -| `cardNumber` | `string` | All the digits (unencrypted) of the credit card number associated with the payment. | -| `cardType` | [`CreditCardCardTypeEnum`](../type-aliases/type-alias.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` _ `VISA` : `VISA` _ `VISA` : `VISA_DELTA` _ `VISA` : `VISA_ELECTRON` _ `VISA` : `CARTA_SI` _ `VISA` : `CARTE_BLEUE` _ `VISA` : `VISA_DANKORT` _ `VISA` : `POSTEPAY_VISA_ELECTRON` | -| `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. | -| `expiryDate` | `Date` | Expiration date of the credit card used for payment, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | -| `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. | -| `readonly` `method` | `"CREDIT_CARD"` | - | -| `operations`? | [`Operations`](class.Operations.md) | - | -| `reason`? | [`PaymentReason`](../type-aliases/type-alias.PaymentReason.md) | - | -| `telephones` | [`Telephone`](class.Telephone.md)[] | Telephone(s) associated with card holder and credit card. | -| `threeDigitsSecureCriteria`? | [`PaymentThreeDSCriteria`](class.PaymentThreeDSCriteria.md) | - | -| `verifiedAmount`? | [`Amount`](class.Amount.md) | - | -| `virtualCreditCardFlag`? | `boolean` | A flag to indicate that the bank card being used for the charge is a virtual credit card. | -| `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`. | diff --git a/release/fraudPreventionV2/docs/models/classes/class.Cruise.md b/release/fraudPreventionV2/docs/models/classes/class.Cruise.md deleted file mode 100644 index da669fd9..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.Cruise.md +++ /dev/null @@ -1,49 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > Cruise - -# Class: Cruise - -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` - -## Extends - -- [`TravelProduct`](class.TravelProduct.md) - -## Constructors - -### constructor() - -> **new Cruise**(`cruise`): [`Cruise`](class.Cruise.md) - -#### Parameters - -| Parameter | Type | -| :-------- | :---------------------------------------------------------------- | -| `cruise` | [`CruiseProperties`](../interfaces/interface.CruiseProperties.md) | - -#### Returns - -[`Cruise`](class.Cruise.md) - -#### Overrides - -[`TravelProduct`](class.TravelProduct.md).[`constructor`](class.TravelProduct.md#constructor) - -#### Source - -models/Cruise.ts:56 - -## Properties - -| Property | Type | Description | -| :--------------------- | :--------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `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`. | -| `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`. | -| `disembarkationPort` | `string` | The cruise\'s final destination. | -| `embarkationPort` | `string` | Location from where cruise will depart. | -| `inventorySource` | [`TravelProductInventorySourceEnum`](../type-aliases/type-alias.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`](class.Amount.md) | - | -| `shipName` | `string` | Name of the cruise ship. | -| `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. | -| `readonly` `type` | `"CRUISE"` | - | diff --git a/release/fraudPreventionV2/docs/models/classes/class.CurrentUserSession.md b/release/fraudPreventionV2/docs/models/classes/class.CurrentUserSession.md deleted file mode 100644 index 74e812cd..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.CurrentUserSession.md +++ /dev/null @@ -1,33 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > CurrentUserSession - -# Class: CurrentUserSession - -The current user session prior to this transaction, which contains details related to any challenge initiated by the Partner\'\'s system to a user before calling Expedia\'\'s Fraud Prevention Service. An example is if the Partner\'\'s system sent a Captcha challenge to the user before calling Expedia\'\'s Fraud Prevention Service. - -## Constructors - -### constructor() - -> **new CurrentUserSession**(`currentUserSession`): [`CurrentUserSession`](class.CurrentUserSession.md) - -#### Parameters - -| Parameter | Type | -| :------------------- | :---------------------------------------------------------------------------------------- | -| `currentUserSession` | [`CurrentUserSessionProperties`](../interfaces/interface.CurrentUserSessionProperties.md) | - -#### Returns - -[`CurrentUserSession`](class.CurrentUserSession.md) - -#### Source - -models/CurrentUserSession.ts:47 - -## Properties - -| Property | Type | Description | -| :----------------- | :-------------------------------------------- | :-------------------------------------------------------------------------------------------------------------- | -| `challengeDetail`? | [`ChallengeDetail`](class.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/class.CustomerAccount.md b/release/fraudPreventionV2/docs/models/classes/class.CustomerAccount.md deleted file mode 100644 index 3235cfdc..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.CustomerAccount.md +++ /dev/null @@ -1,35 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > CustomerAccount - -# Class: CustomerAccount - -## Constructors - -### constructor() - -> **new CustomerAccount**(`customerAccount`): [`CustomerAccount`](class.CustomerAccount.md) - -#### Parameters - -| Parameter | Type | -| :---------------- | :---------------------------------------------------------------------------------- | -| `customerAccount` | [`CustomerAccountProperties`](../interfaces/interface.CustomerAccountProperties.md) | - -#### Returns - -[`CustomerAccount`](class.CustomerAccount.md) - -#### Source - -models/CustomerAccount.ts:70 - -## Properties - -| Property | Type | Description | -| :---------------- | :----------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `accountType` | [`CustomerAccountAccountTypeEnum`](../type-aliases/type-alias.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`](class.CustomerAccountAddress.md) | - | -| `emailAddress` | `string` | Email address for the account owner. | -| `name` | [`Name`](class.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`](class.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/class.CustomerAccountAddress.md b/release/fraudPreventionV2/docs/models/classes/class.CustomerAccountAddress.md deleted file mode 100644 index 19931c24..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.CustomerAccountAddress.md +++ /dev/null @@ -1,35 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > CustomerAccountAddress - -# Class: CustomerAccountAddress - -## Constructors - -### constructor() - -> **new CustomerAccountAddress**(`customerAccountAddress`): [`CustomerAccountAddress`](class.CustomerAccountAddress.md) - -#### Parameters - -| Parameter | Type | -| :----------------------- | :------------------------------------------------------------------------------------------------ | -| `customerAccountAddress` | [`CustomerAccountAddressProperties`](../interfaces/interface.CustomerAccountAddressProperties.md) | - -#### Returns - -[`CustomerAccountAddress`](class.CustomerAccountAddress.md) - -#### Source - -models/CustomerAccountAddress.ts:58 - -## Properties - -| 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/type-alias.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/class.DeviceDetails.md b/release/fraudPreventionV2/docs/models/classes/class.DeviceDetails.md deleted file mode 100644 index dd475d29..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.DeviceDetails.md +++ /dev/null @@ -1,31 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > DeviceDetails - -# Class: DeviceDetails - -## Constructors - -### constructor() - -> **new DeviceDetails**(`deviceDetails`): [`DeviceDetails`](class.DeviceDetails.md) - -#### Parameters - -| Parameter | Type | -| :-------------- | :------------------------------------------------------------------------------ | -| `deviceDetails` | [`DeviceDetailsProperties`](../interfaces/interface.DeviceDetailsProperties.md) | - -#### Returns - -[`DeviceDetails`](class.DeviceDetails.md) - -#### Source - -models/DeviceDetails.ts:41 - -## Properties - -| 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/class.DirectDebit.md b/release/fraudPreventionV2/docs/models/classes/class.DirectDebit.md deleted file mode 100644 index 6d7d821b..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.DirectDebit.md +++ /dev/null @@ -1,51 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > DirectDebit - -# Class: DirectDebit - -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` - -## Extends - -- [`Payment`](class.Payment.md) - -## Constructors - -### constructor() - -> **new DirectDebit**(`directDebit`): [`DirectDebit`](class.DirectDebit.md) - -#### Parameters - -| Parameter | Type | -| :------------ | :-------------------------------------------------------------------------- | -| `directDebit` | [`DirectDebitProperties`](../interfaces/interface.DirectDebitProperties.md) | - -#### Returns - -[`DirectDebit`](class.DirectDebit.md) - -#### Overrides - -[`Payment`](class.Payment.md).[`constructor`](class.Payment.md#constructor) - -#### Source - -models/DirectDebit.ts:52 - -## Properties - -| Property | Type | Description | -| :--------------------------- | :------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `accountNumber` | `string` | Cleartext (unencrypted) DirectDebit bank account number associated with the payment instrument. | -| `authorizedAmount`? | [`Amount`](class.Amount.md) | - | -| `billingAddress` | [`PaymentBillingAddress`](class.PaymentBillingAddress.md) | - | -| `billingEmailAddress` | `string` | Email address associated with the payment. | -| `billingName` | [`Name`](class.Name.md) | - | -| `brand` | [`PaymentBrandEnum`](../type-aliases/type-alias.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` _ `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` | -| `readonly` `method` | `"DIRECT_DEBIT"` | - | -| `operations`? | [`Operations`](class.Operations.md) | - | -| `reason`? | [`PaymentReason`](../type-aliases/type-alias.PaymentReason.md) | - | -| `routingNumber` | `string` | A code that identifies the financial institution for a specific bank account. | -| `telephones` | [`Telephone`](class.Telephone.md)[] | Telephone(s) associated with direct debit payment provider. | -| `threeDigitsSecureCriteria`? | [`PaymentThreeDSCriteria`](class.PaymentThreeDSCriteria.md) | - | -| `verifiedAmount`? | [`Amount`](class.Amount.md) | - | diff --git a/release/fraudPreventionV2/docs/models/classes/class.Email.md b/release/fraudPreventionV2/docs/models/classes/class.Email.md deleted file mode 100644 index 7a61ef5f..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.Email.md +++ /dev/null @@ -1,31 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > Email - -# Class: Email - -Group of attributes intended to hold information about email address associated with the transaction. - -## Constructors - -### constructor() - -> **new Email**(`email`): [`Email`](class.Email.md) - -#### Parameters - -| Parameter | Type | -| :-------- | :-------------------------------------------------------------- | -| `email` | [`EmailProperties`](../interfaces/interface.EmailProperties.md) | - -#### Returns - -[`Email`](class.Email.md) - -#### Source - -models/Email.ts:34 - -## Properties - -| Property | Type | Description | -| :-------------- | :------- | :------------------------------------------------------------------------- | -| `emailAddress`? | `string` | Full email address including the alias, @ symbol, domain, and root domain. | diff --git a/release/fraudPreventionV2/docs/models/classes/class.ForbiddenError.md b/release/fraudPreventionV2/docs/models/classes/class.ForbiddenError.md deleted file mode 100644 index c545039f..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.ForbiddenError.md +++ /dev/null @@ -1,32 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > ForbiddenError - -# Class: ForbiddenError - -Indicates that the API cannot fulfill the request because while the client is correctly authenticated, the client doesn\'t have the permission to execute the specified operation. This error type does not imply that the request is valid, or that the resource against which the operation being performed exists or satisfies other pre-conditions. - -## Constructors - -### constructor() - -> **new ForbiddenError**(`forbiddenError`): [`ForbiddenError`](class.ForbiddenError.md) - -#### Parameters - -| Parameter | Type | -| :--------------- | :-------------------------------------------------------------------------------- | -| `forbiddenError` | [`ForbiddenErrorProperties`](../interfaces/interface.ForbiddenErrorProperties.md) | - -#### Returns - -[`ForbiddenError`](class.ForbiddenError.md) - -#### Source - -models/ForbiddenError.ts:39 - -## Properties - -| Property | Type | Description | -| :-------- | :------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------- | -| `code` | [`ForbiddenErrorCodeEnum`](../type-aliases/type-alias.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/class.GatewayTimeoutError.md b/release/fraudPreventionV2/docs/models/classes/class.GatewayTimeoutError.md deleted file mode 100644 index 8b31bbb2..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.GatewayTimeoutError.md +++ /dev/null @@ -1,32 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > GatewayTimeoutError - -# 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. - -## Constructors - -### constructor() - -> **new GatewayTimeoutError**(`gatewayTimeoutError`): [`GatewayTimeoutError`](class.GatewayTimeoutError.md) - -#### Parameters - -| Parameter | Type | -| :-------------------- | :------------------------------------------------------------------------------------------ | -| `gatewayTimeoutError` | [`GatewayTimeoutErrorProperties`](../interfaces/interface.GatewayTimeoutErrorProperties.md) | - -#### Returns - -[`GatewayTimeoutError`](class.GatewayTimeoutError.md) - -#### Source - -models/GatewayTimeoutError.ts:39 - -## Properties - -| Property | Type | Description | -| :-------- | :----------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------- | -| `code` | [`GatewayTimeoutErrorCodeEnum`](../type-aliases/type-alias.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/class.GiftCard.md b/release/fraudPreventionV2/docs/models/classes/class.GiftCard.md deleted file mode 100644 index 67800984..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.GiftCard.md +++ /dev/null @@ -1,51 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > GiftCard - -# Class: GiftCard - -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` - -## Extends - -- [`Payment`](class.Payment.md) - -## Constructors - -### constructor() - -> **new GiftCard**(`giftCard`): [`GiftCard`](class.GiftCard.md) - -#### Parameters - -| Parameter | Type | -| :--------- | :-------------------------------------------------------------------- | -| `giftCard` | [`GiftCardProperties`](../interfaces/interface.GiftCardProperties.md) | - -#### Returns - -[`GiftCard`](class.GiftCard.md) - -#### Overrides - -[`Payment`](class.Payment.md).[`constructor`](class.Payment.md#constructor) - -#### Source - -models/GiftCard.ts:46 - -## Properties - -| Property | Type | Description | -| :--------------------------- | :------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `authorizedAmount`? | [`Amount`](class.Amount.md) | - | -| `billingAddress` | [`PaymentBillingAddress`](class.PaymentBillingAddress.md) | - | -| `billingEmailAddress` | `string` | Email address associated with the payment. | -| `billingName` | [`Name`](class.Name.md) | - | -| `brand` | [`PaymentBrandEnum`](../type-aliases/type-alias.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` _ `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` | -| `cardHolderName` | `string` | The name of gift card holder. | -| `cardNumber` | `string` | Gift card number. | -| `readonly` `method` | `"GIFT_CARD"` | - | -| `operations`? | [`Operations`](class.Operations.md) | - | -| `pin` | `string` | The PIN of gift card. | -| `reason`? | [`PaymentReason`](../type-aliases/type-alias.PaymentReason.md) | - | -| `threeDigitsSecureCriteria`? | [`PaymentThreeDSCriteria`](class.PaymentThreeDSCriteria.md) | - | -| `verifiedAmount`? | [`Amount`](class.Amount.md) | - | diff --git a/release/fraudPreventionV2/docs/models/classes/class.Hotel.md b/release/fraudPreventionV2/docs/models/classes/class.Hotel.md deleted file mode 100644 index b9efc30e..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.Hotel.md +++ /dev/null @@ -1,51 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > Hotel - -# Class: Hotel - -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` - -## Extends - -- [`TravelProduct`](class.TravelProduct.md) - -## Constructors - -### constructor() - -> **new Hotel**(`hotel`): [`Hotel`](class.Hotel.md) - -#### Parameters - -| Parameter | Type | -| :-------- | :-------------------------------------------------------------- | -| `hotel` | [`HotelProperties`](../interfaces/interface.HotelProperties.md) | - -#### Returns - -[`Hotel`](class.Hotel.md) - -#### Overrides - -[`TravelProduct`](class.TravelProduct.md).[`constructor`](class.TravelProduct.md#constructor) - -#### Source - -models/Hotel.ts:69 - -## Properties - -| Property | Type | Description | -| :--------------------- | :--------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `address` | [`HotelAllOfAddress`](class.HotelAllOfAddress.md) | - | -| `checkinTime` | `Date` | Local date and time of the hotel check-in, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | -| `checkoutTime` | `Date` | Local date and time of the hotel check-out, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | -| `hotelId` | `string` | Unique hotel identifier assigned by the partner. | -| `hotelName` | `string` | Name of the hotel. | -| `inventorySource` | [`TravelProductInventorySourceEnum`](../type-aliases/type-alias.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`](class.Amount.md) | - | -| `priceWithheld`? | `boolean` | Identifies if the product price was withheld from the customer during the booking process. | -| `roomCount`? | `number` | Total number of rooms booked within the hotel product collection. | -| `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. | -| `readonly` `type` | `"HOTEL"` | - | diff --git a/release/fraudPreventionV2/docs/models/classes/class.HotelAddress.md b/release/fraudPreventionV2/docs/models/classes/class.HotelAddress.md deleted file mode 100644 index 0743c0e7..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.HotelAddress.md +++ /dev/null @@ -1,37 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > HotelAddress - -# Class: HotelAddress - -Address of a hotel. - -## Constructors - -### constructor() - -> **new HotelAddress**(`hotelAddress`): [`HotelAddress`](class.HotelAddress.md) - -#### Parameters - -| Parameter | Type | -| :------------- | :---------------------------------------------------------------------------- | -| `hotelAddress` | [`HotelAddressProperties`](../interfaces/interface.HotelAddressProperties.md) | - -#### Returns - -[`HotelAddress`](class.HotelAddress.md) - -#### Source - -models/HotelAddress.ts:61 - -## Properties - -| 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/type-alias.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/class.HotelAllOfAddress.md b/release/fraudPreventionV2/docs/models/classes/class.HotelAllOfAddress.md deleted file mode 100644 index 5ddb7aac..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.HotelAllOfAddress.md +++ /dev/null @@ -1,35 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > HotelAllOfAddress - -# Class: HotelAllOfAddress - -## Constructors - -### constructor() - -> **new HotelAllOfAddress**(`hotelAllOfAddress`): [`HotelAllOfAddress`](class.HotelAllOfAddress.md) - -#### Parameters - -| Parameter | Type | -| :------------------ | :-------------------------------------------------------------------------------------- | -| `hotelAllOfAddress` | [`HotelAllOfAddressProperties`](../interfaces/interface.HotelAllOfAddressProperties.md) | - -#### Returns - -[`HotelAllOfAddress`](class.HotelAllOfAddress.md) - -#### Source - -models/HotelAllOfAddress.ts:58 - -## Properties - -| Property | Type | Description | -| :-------------- | :--------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------- | -| `addressLine1` | `string` | Address line 1 of the address provided. | -| `addressLine2`? | `string` | Address line 2 of the address provided. | -| `addressType`? | [`HotelAllOfAddressAddressTypeEnum`](../type-aliases/type-alias.HotelAllOfAddressAddressTypeEnum.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/class.InsultDetail.md b/release/fraudPreventionV2/docs/models/classes/class.InsultDetail.md deleted file mode 100644 index 89a3bbec..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.InsultDetail.md +++ /dev/null @@ -1,31 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > InsultDetail - -# Class: InsultDetail - -Details related to the insult. - -## Constructors - -### constructor() - -> **new InsultDetail**(`insultDetail`): [`InsultDetail`](class.InsultDetail.md) - -#### Parameters - -| Parameter | Type | -| :------------- | :---------------------------------------------------------------------------- | -| `insultDetail` | [`InsultDetailProperties`](../interfaces/interface.InsultDetailProperties.md) | - -#### Returns - -[`InsultDetail`](class.InsultDetail.md) - -#### Source - -models/InsultDetail.ts:34 - -## Properties - -| 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/class.InsultFeedback.md b/release/fraudPreventionV2/docs/models/classes/class.InsultFeedback.md deleted file mode 100644 index e7d88dfa..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.InsultFeedback.md +++ /dev/null @@ -1,41 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > InsultFeedback - -# Class: InsultFeedback - -Feedback from EG external partners regarding a false positive recommendation that from Fraud Prevention system gave for their customer. - -## Extends - -- [`OrderPurchaseUpdateRequest`](class.OrderPurchaseUpdateRequest.md) - -## Constructors - -### constructor() - -> **new InsultFeedback**(`insultFeedback`): [`InsultFeedback`](class.InsultFeedback.md) - -#### Parameters - -| Parameter | Type | -| :--------------- | :-------------------------------------------------------------------------------- | -| `insultFeedback` | [`InsultFeedbackProperties`](../interfaces/interface.InsultFeedbackProperties.md) | - -#### Returns - -[`InsultFeedback`](class.InsultFeedback.md) - -#### Overrides - -[`OrderPurchaseUpdateRequest`](class.OrderPurchaseUpdateRequest.md).[`constructor`](class.OrderPurchaseUpdateRequest.md#constructor) - -#### Source - -models/InsultFeedback.ts:41 - -## Properties - -| Property | Type | Description | -| :---------------- | :-------------------------------------- | :-------------------------------------------------------------------------------------------------- | -| `insultDetail`? | [`InsultDetail`](class.InsultDetail.md) | - | -| `riskId` | `string` | The `risk_id` provided by Expedia\'s Fraud Prevention Service in the `OrderPurchaseScreenResponse`. | -| `readonly` `type` | `"INSULT_FEEDBACK"` | - | diff --git a/release/fraudPreventionV2/docs/models/classes/class.Insurance.md b/release/fraudPreventionV2/docs/models/classes/class.Insurance.md deleted file mode 100644 index 1e3d01dc..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.Insurance.md +++ /dev/null @@ -1,44 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > Insurance - -# Class: Insurance - -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` - -## Extends - -- [`TravelProduct`](class.TravelProduct.md) - -## Constructors - -### constructor() - -> **new Insurance**(`insurance`): [`Insurance`](class.Insurance.md) - -#### Parameters - -| Parameter | Type | -| :---------- | :---------------------------------------------------------------------- | -| `insurance` | [`InsuranceProperties`](../interfaces/interface.InsuranceProperties.md) | - -#### Returns - -[`Insurance`](class.Insurance.md) - -#### Overrides - -[`TravelProduct`](class.TravelProduct.md).[`constructor`](class.TravelProduct.md#constructor) - -#### Source - -models/Insurance.ts:30 - -## Properties - -| Property | Type | Description | -| :--------------------- | :--------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `inventorySource` | [`TravelProductInventorySourceEnum`](../type-aliases/type-alias.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`](class.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. | -| `readonly` `type` | `"INSURANCE"` | - | diff --git a/release/fraudPreventionV2/docs/models/classes/class.InternalServerError.md b/release/fraudPreventionV2/docs/models/classes/class.InternalServerError.md deleted file mode 100644 index 4ac521d7..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.InternalServerError.md +++ /dev/null @@ -1,32 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > InternalServerError - -# Class: InternalServerError - -Indicates that the API encountered an unexpected condition that prevented it from fulfilling the request. Sometimes used as a generic catch-allerror type when no other error types can be used. Retrying the same request will usually result in the same error. Please reach out to support team as next step for this error resolution. - -## Constructors - -### constructor() - -> **new InternalServerError**(`internalServerError`): [`InternalServerError`](class.InternalServerError.md) - -#### Parameters - -| Parameter | Type | -| :-------------------- | :------------------------------------------------------------------------------------------ | -| `internalServerError` | [`InternalServerErrorProperties`](../interfaces/interface.InternalServerErrorProperties.md) | - -#### Returns - -[`InternalServerError`](class.InternalServerError.md) - -#### Source - -models/InternalServerError.ts:39 - -## Properties - -| Property | Type | Description | -| :-------- | :----------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------- | -| `code` | [`InternalServerErrorCodeEnum`](../type-aliases/type-alias.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/class.InternetBankPayment.md b/release/fraudPreventionV2/docs/models/classes/class.InternetBankPayment.md deleted file mode 100644 index f520f0d8..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.InternetBankPayment.md +++ /dev/null @@ -1,51 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > InternetBankPayment - -# Class: InternetBankPayment - -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` - -## Extends - -- [`Payment`](class.Payment.md) - -## Constructors - -### constructor() - -> **new InternetBankPayment**(`internetBankPayment`): [`InternetBankPayment`](class.InternetBankPayment.md) - -#### Parameters - -| Parameter | Type | -| :-------------------- | :------------------------------------------------------------------------------------------ | -| `internetBankPayment` | [`InternetBankPaymentProperties`](../interfaces/interface.InternetBankPaymentProperties.md) | - -#### Returns - -[`InternetBankPayment`](class.InternetBankPayment.md) - -#### Overrides - -[`Payment`](class.Payment.md).[`constructor`](class.Payment.md#constructor) - -#### Source - -models/InternetBankPayment.ts:52 - -## Properties - -| Property | Type | Description | -| :--------------------------- | :------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `authorizedAmount`? | [`Amount`](class.Amount.md) | - | -| `bankBranchCode` | `string` | A code that identifies the bank branch for internet bank payment(IBP). | -| `bankId` | `string` | The bank_id provided by the internet bank payment(IBP) provider (DRWP aka NetGiro) for the bank used for processing the payment. | -| `billingAddress` | [`PaymentBillingAddress`](class.PaymentBillingAddress.md) | - | -| `billingEmailAddress` | `string` | Email address associated with the payment. | -| `billingName` | [`Name`](class.Name.md) | - | -| `brand` | [`PaymentBrandEnum`](../type-aliases/type-alias.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` _ `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` | -| `readonly` `method` | `"INTERNET_BANK_PAYMENT"` | - | -| `operations`? | [`Operations`](class.Operations.md) | - | -| `reason`? | [`PaymentReason`](../type-aliases/type-alias.PaymentReason.md) | - | -| `telephones` | [`Telephone`](class.Telephone.md)[] | Telephone(s) associated with internet bank payment(IBP) provider. | -| `threeDigitsSecureCriteria`? | [`PaymentThreeDSCriteria`](class.PaymentThreeDSCriteria.md) | - | -| `verifiedAmount`? | [`Amount`](class.Amount.md) | - | diff --git a/release/fraudPreventionV2/docs/models/classes/class.IssuedRefundUpdate.md b/release/fraudPreventionV2/docs/models/classes/class.IssuedRefundUpdate.md deleted file mode 100644 index 127883af..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.IssuedRefundUpdate.md +++ /dev/null @@ -1,42 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > IssuedRefundUpdate - -# Class: IssuedRefundUpdate - -Data related to the issued refund that should be updated. - -## Extends - -- [`RefundUpdate`](class.RefundUpdate.md) - -## Constructors - -### constructor() - -> **new IssuedRefundUpdate**(`issuedRefundUpdate`): [`IssuedRefundUpdate`](class.IssuedRefundUpdate.md) - -#### Parameters - -| Parameter | Type | -| :------------------- | :---------------------------------------------------------------------------------------- | -| `issuedRefundUpdate` | [`IssuedRefundUpdateProperties`](../interfaces/interface.IssuedRefundUpdateProperties.md) | - -#### Returns - -[`IssuedRefundUpdate`](class.IssuedRefundUpdate.md) - -#### Overrides - -[`RefundUpdate`](class.RefundUpdate.md).[`constructor`](class.RefundUpdate.md#constructor) - -#### Source - -models/IssuedRefundUpdate.ts:41 - -## Properties - -| Property | Type | Description | -| :------------------------ | :---------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------- | -| `refundDetails`? | [`IssuedRefundUpdateDetails`](class.IssuedRefundUpdateDetails.md) | - | -| `readonly` `refundStatus` | `"ISSUED"` | - | -| `riskId` | `string` | The `risk_id` provided by Expedia\'s Fraud Prevention Service in the `OrderPurchaseScreenResponse`. | -| `readonly` `type` | `"REFUND_UPDATE"` | - | diff --git a/release/fraudPreventionV2/docs/models/classes/class.IssuedRefundUpdateDetails.md b/release/fraudPreventionV2/docs/models/classes/class.IssuedRefundUpdateDetails.md deleted file mode 100644 index 7a2c7cdb..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.IssuedRefundUpdateDetails.md +++ /dev/null @@ -1,32 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > IssuedRefundUpdateDetails - -# Class: IssuedRefundUpdateDetails - -Data that describes issued refund that should be updated. - -## Constructors - -### constructor() - -> **new IssuedRefundUpdateDetails**(`issuedRefundUpdateDetails`): [`IssuedRefundUpdateDetails`](class.IssuedRefundUpdateDetails.md) - -#### Parameters - -| Parameter | Type | -| :-------------------------- | :------------------------------------------------------------------------------------------------------ | -| `issuedRefundUpdateDetails` | [`IssuedRefundUpdateDetailsProperties`](../interfaces/interface.IssuedRefundUpdateDetailsProperties.md) | - -#### Returns - -[`IssuedRefundUpdateDetails`](class.IssuedRefundUpdateDetails.md) - -#### Source - -models/IssuedRefundUpdateDetails.ts:42 - -## Properties - -| Property | Type | Description | -| :--------------------- | :-------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `refundIssuedAmount` | [`Amount`](class.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/class.LoginTransactionDetails.md b/release/fraudPreventionV2/docs/models/classes/class.LoginTransactionDetails.md deleted file mode 100644 index a8fc55d9..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.LoginTransactionDetails.md +++ /dev/null @@ -1,46 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > LoginTransactionDetails - -# Class: LoginTransactionDetails - -The `transaction_type` field value is used as a discriminator, with the following mapping: \* `LOGIN`: `LoginTransactionDetails` - -## Extends - -- [`AccountTakeoverTransactionDetails`](class.AccountTakeoverTransactionDetails.md) - -## Constructors - -### constructor() - -> **new LoginTransactionDetails**(`loginTransactionDetails`): [`LoginTransactionDetails`](class.LoginTransactionDetails.md) - -#### Parameters - -| Parameter | Type | -| :------------------------ | :-------------------------------------------------------------------------------------------------- | -| `loginTransactionDetails` | [`LoginTransactionDetailsProperties`](../interfaces/interface.LoginTransactionDetailsProperties.md) | - -#### Returns - -[`LoginTransactionDetails`](class.LoginTransactionDetails.md) - -#### Overrides - -[`AccountTakeoverTransactionDetails`](class.AccountTakeoverTransactionDetails.md).[`constructor`](class.AccountTakeoverTransactionDetails.md#constructor) - -#### Source - -models/LoginTransactionDetails.ts:51 - -## Properties - -| Property | Type | Description | -| :----------------------- | :----------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `authenticationSubType`? | [`LoginTransactionDetailsAuthenticationSubTypeEnum`](../type-aliases/type-alias.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` | [`LoginTransactionDetailsAuthenticationTypeEnum`](../type-aliases/type-alias.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`? | [`CurrentUserSession`](class.CurrentUserSession.md) | - | -| `failedLoginReason`? | [`LoginTransactionDetailsFailedLoginReasonEnum`](../type-aliases/type-alias.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` | `boolean` | Identifies if a login attempt by a user was successful or not. | -| `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. | -| `readonly` `type` | `"LOGIN"` | - | diff --git a/release/fraudPreventionV2/docs/models/classes/class.ModelError.md b/release/fraudPreventionV2/docs/models/classes/class.ModelError.md deleted file mode 100644 index 39443af0..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.ModelError.md +++ /dev/null @@ -1,32 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > ModelError - -# Class: ModelError - -The object used to describe an error, containing both human-readable and machine-readable information. - -## Constructors - -### constructor() - -> **new ModelError**(`error`): [`ModelError`](class.ModelError.md) - -#### Parameters - -| Parameter | Type | -| :-------- | :------------------------------------------------------------------------ | -| `error` | [`ModelErrorProperties`](../interfaces/interface.ModelErrorProperties.md) | - -#### Returns - -[`ModelError`](class.ModelError.md) - -#### Source - -models/ModelError.ts:39 - -## Properties - -| Property | Type | Description | -| :-------- | :----------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------- | -| `code` | [`ModelErrorCodeEnum`](../type-aliases/type-alias.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/class.MultiFactorAuthenticationAttempt.md b/release/fraudPreventionV2/docs/models/classes/class.MultiFactorAuthenticationAttempt.md deleted file mode 100644 index 6fae2c4e..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.MultiFactorAuthenticationAttempt.md +++ /dev/null @@ -1,39 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > MultiFactorAuthenticationAttempt - -# Class: MultiFactorAuthenticationAttempt - -Information specific to the update event by a user. - -## Constructors - -### constructor() - -> **new MultiFactorAuthenticationAttempt**(`multiFactorAuthenticationAttempt`): [`MultiFactorAuthenticationAttempt`](class.MultiFactorAuthenticationAttempt.md) - -#### Parameters - -| Parameter | Type | -| :--------------------------------- | :-------------------------------------------------------------------------------------------------------------------- | -| `multiFactorAuthenticationAttempt` | [`MultiFactorAuthenticationAttemptProperties`](../interfaces/interface.MultiFactorAuthenticationAttemptProperties.md) | - -#### Returns - -[`MultiFactorAuthenticationAttempt`](class.MultiFactorAuthenticationAttempt.md) - -#### Source - -models/MultiFactorAuthenticationAttempt.ts:77 - -## Properties - -| Property | Type | Description | -| :--------------------- | :--------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `attemptCount` | `number` | The number of attempts a user tried for this Multi-Factor Authentication. | -| `deliveryMethod` | [`MultiFactorAuthenticationAttemptDeliveryMethodEnum`](../type-aliases/type-alias.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/type-alias.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`](class.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/class.MultiFactorAuthenticationUpdate.md b/release/fraudPreventionV2/docs/models/classes/class.MultiFactorAuthenticationUpdate.md deleted file mode 100644 index d5ca2317..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.MultiFactorAuthenticationUpdate.md +++ /dev/null @@ -1,41 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > MultiFactorAuthenticationUpdate - -# Class: MultiFactorAuthenticationUpdate - -Information specific to a user\'s response to a Multi-Factor Authentication initiated by the Partner\'s system as a result of a fraud recommendation. - -## Extends - -- [`AccountUpdateRequest`](class.AccountUpdateRequest.md) - -## Constructors - -### constructor() - -> **new MultiFactorAuthenticationUpdate**(`multiFactorAuthenticationUpdate`): [`MultiFactorAuthenticationUpdate`](class.MultiFactorAuthenticationUpdate.md) - -#### Parameters - -| Parameter | Type | -| :-------------------------------- | :------------------------------------------------------------------------------------------------------------------ | -| `multiFactorAuthenticationUpdate` | [`MultiFactorAuthenticationUpdateProperties`](../interfaces/interface.MultiFactorAuthenticationUpdateProperties.md) | - -#### Returns - -[`MultiFactorAuthenticationUpdate`](class.MultiFactorAuthenticationUpdate.md) - -#### Overrides - -[`AccountUpdateRequest`](class.AccountUpdateRequest.md).[`constructor`](class.AccountUpdateRequest.md#constructor) - -#### Source - -models/MultiFactorAuthenticationUpdate.ts:43 - -## Properties - -| Property | Type | Description | -| :---------------------------------- | :-------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------- | -| `multiFactorAuthenticationAttempts` | [`MultiFactorAuthenticationAttempt`](class.MultiFactorAuthenticationAttempt.md)[] | - | -| `riskId` | `string` | The `risk_id` provided by Expedia\'s Fraud Prevention Service in the `AccountScreenResponse`. | -| `readonly` `type` | `"MULTI_FACTOR_AUTHENTICATION_UPDATE"` | - | diff --git a/release/fraudPreventionV2/docs/models/classes/class.Name.md b/release/fraudPreventionV2/docs/models/classes/class.Name.md deleted file mode 100644 index c27354ec..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.Name.md +++ /dev/null @@ -1,35 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > Name - -# Class: Name - -Group of attributes intended to hold information about a customer or traveler\'s name for the order. - -## Constructors - -### constructor() - -> **new Name**(`name`): [`Name`](class.Name.md) - -#### Parameters - -| Parameter | Type | -| :-------- | :------------------------------------------------------------ | -| `name` | [`NameProperties`](../interfaces/interface.NameProperties.md) | - -#### Returns - -[`Name`](class.Name.md) - -#### Source - -models/Name.ts:54 - -## Properties - -| 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/class.NotFoundError.md b/release/fraudPreventionV2/docs/models/classes/class.NotFoundError.md deleted file mode 100644 index 962ba41b..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.NotFoundError.md +++ /dev/null @@ -1,32 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > NotFoundError - -# Class: NotFoundError - -Indicates that the API cannot find the resource that is either being requested or against which the operation is being performed. Please check the request again to make sure that the request is valid. - -## Constructors - -### constructor() - -> **new NotFoundError**(`notFoundError`): [`NotFoundError`](class.NotFoundError.md) - -#### Parameters - -| Parameter | Type | -| :-------------- | :------------------------------------------------------------------------------ | -| `notFoundError` | [`NotFoundErrorProperties`](../interfaces/interface.NotFoundErrorProperties.md) | - -#### Returns - -[`NotFoundError`](class.NotFoundError.md) - -#### Source - -models/NotFoundError.ts:39 - -## Properties - -| Property | Type | Description | -| :-------- | :----------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------- | -| `code` | [`NotFoundErrorCodeEnum`](../type-aliases/type-alias.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/class.Operations.md b/release/fraudPreventionV2/docs/models/classes/class.Operations.md deleted file mode 100644 index 517c187f..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.Operations.md +++ /dev/null @@ -1,35 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > Operations - -# Class: Operations - -All operations related to a payment throughout its lifespan. An operation represents an event external to Fraud Prevention Service that specifies to perform a payment operation. Possible operation types include: - `Verify` - `Authorize` - `AuthorizeReversal` - `Capture` - `Refund` - -## Constructors - -### constructor() - -> **new Operations**(`operations`): [`Operations`](class.Operations.md) - -#### Parameters - -| Parameter | Type | -| :----------- | :------------------------------------------------------------------------ | -| `operations` | [`OperationsProperties`](../interfaces/interface.OperationsProperties.md) | - -#### Returns - -[`Operations`](class.Operations.md) - -#### Source - -models/Operations.ts:68 - -## Properties - -| Property | Type | -| :------------------- | :------------------------------------------------ | -| `authorize`? | [`Authorize`](class.Authorize.md) | -| `authorizeReversal`? | [`AuthorizeReversal`](class.AuthorizeReversal.md) | -| `capture`? | [`Capture`](class.Capture.md) | -| `refunds`? | [`Refund`](class.Refund.md)[] | -| `verify`? | [`Verify`](class.Verify.md) | diff --git a/release/fraudPreventionV2/docs/models/classes/class.OrderPurchaseScreenRequest.md b/release/fraudPreventionV2/docs/models/classes/class.OrderPurchaseScreenRequest.md deleted file mode 100644 index c62e4007..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.OrderPurchaseScreenRequest.md +++ /dev/null @@ -1,29 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > OrderPurchaseScreenRequest - -# Class: OrderPurchaseScreenRequest - -## Constructors - -### constructor() - -> **new OrderPurchaseScreenRequest**(`orderPurchaseScreenRequest`): [`OrderPurchaseScreenRequest`](class.OrderPurchaseScreenRequest.md) - -#### Parameters - -| Parameter | Type | -| :--------------------------- | :-------------------------------------------------------------------------------------------------------- | -| `orderPurchaseScreenRequest` | [`OrderPurchaseScreenRequestProperties`](../interfaces/interface.OrderPurchaseScreenRequestProperties.md) | - -#### Returns - -[`OrderPurchaseScreenRequest`](class.OrderPurchaseScreenRequest.md) - -#### Source - -models/OrderPurchaseScreenRequest.ts:33 - -## Properties - -| Property | Type | -| :------------ | :-------------------------------------------------------------- | -| `transaction` | [`OrderPurchaseTransaction`](class.OrderPurchaseTransaction.md) | diff --git a/release/fraudPreventionV2/docs/models/classes/class.OrderPurchaseScreenResponse.md b/release/fraudPreventionV2/docs/models/classes/class.OrderPurchaseScreenResponse.md deleted file mode 100644 index 04ad815c..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.OrderPurchaseScreenResponse.md +++ /dev/null @@ -1,30 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > OrderPurchaseScreenResponse - -# Class: OrderPurchaseScreenResponse - -## Constructors - -### constructor() - -> **new OrderPurchaseScreenResponse**(`orderPurchaseScreenResponse`): [`OrderPurchaseScreenResponse`](class.OrderPurchaseScreenResponse.md) - -#### Parameters - -| Parameter | Type | -| :---------------------------- | :---------------------------------------------------------------------------------------------------------- | -| `orderPurchaseScreenResponse` | [`OrderPurchaseScreenResponseProperties`](../interfaces/interface.OrderPurchaseScreenResponseProperties.md) | - -#### Returns - -[`OrderPurchaseScreenResponse`](class.OrderPurchaseScreenResponse.md) - -#### Source - -models/OrderPurchaseScreenResponse.ts:34 - -## Properties - -| Property | Type | Description | -| :---------- | :------------------------------------------------------------- | :------------------------------------------------------------------------------------ | -| `decision`? | [`FraudDecision`](../type-aliases/type-alias.FraudDecision.md) | - | -| `riskId`? | `string` | Unique identifier assigned to the transaction by Expedia\'s Fraud Prevention Service. | diff --git a/release/fraudPreventionV2/docs/models/classes/class.OrderPurchaseTransaction.md b/release/fraudPreventionV2/docs/models/classes/class.OrderPurchaseTransaction.md deleted file mode 100644 index d0983bac..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.OrderPurchaseTransaction.md +++ /dev/null @@ -1,32 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > OrderPurchaseTransaction - -# Class: OrderPurchaseTransaction - -## Constructors - -### constructor() - -> **new OrderPurchaseTransaction**(`orderPurchaseTransaction`): [`OrderPurchaseTransaction`](class.OrderPurchaseTransaction.md) - -#### Parameters - -| Parameter | Type | -| :------------------------- | :---------------------------------------------------------------------------------------------------- | -| `orderPurchaseTransaction` | [`OrderPurchaseTransactionProperties`](../interfaces/interface.OrderPurchaseTransactionProperties.md) | - -#### Returns - -[`OrderPurchaseTransaction`](class.OrderPurchaseTransaction.md) - -#### Source - -models/OrderPurchaseTransaction.ts:57 - -## Properties - -| Property | Type | -| :------------------- | :-------------------------------------------------- | -| `customerAccount` | [`CustomerAccount`](class.CustomerAccount.md) | -| `deviceDetails` | [`DeviceDetails`](class.DeviceDetails.md) | -| `siteInfo` | [`SiteInfo`](class.SiteInfo.md) | -| `transactionDetails` | [`TransactionDetails`](class.TransactionDetails.md) | diff --git a/release/fraudPreventionV2/docs/models/classes/class.OrderPurchaseUpdateNotFoundError.md b/release/fraudPreventionV2/docs/models/classes/class.OrderPurchaseUpdateNotFoundError.md deleted file mode 100644 index dc2dc5ba..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.OrderPurchaseUpdateNotFoundError.md +++ /dev/null @@ -1,32 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > OrderPurchaseUpdateNotFoundError - -# Class: OrderPurchaseUpdateNotFoundError - -Indicates that the API cannot find the resource that is either being requested or against which the operation is being performed. - -## Constructors - -### constructor() - -> **new OrderPurchaseUpdateNotFoundError**(`orderPurchaseUpdateNotFoundError`): [`OrderPurchaseUpdateNotFoundError`](class.OrderPurchaseUpdateNotFoundError.md) - -#### Parameters - -| Parameter | Type | -| :--------------------------------- | :-------------------------------------------------------------------------------------------------------------------- | -| `orderPurchaseUpdateNotFoundError` | [`OrderPurchaseUpdateNotFoundErrorProperties`](../interfaces/interface.OrderPurchaseUpdateNotFoundErrorProperties.md) | - -#### Returns - -[`OrderPurchaseUpdateNotFoundError`](class.OrderPurchaseUpdateNotFoundError.md) - -#### Source - -models/OrderPurchaseUpdateNotFoundError.ts:39 - -## Properties - -| Property | Type | Description | -| :-------- | :------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------- | -| `code` | [`OrderPurchaseUpdateNotFoundErrorCodeEnum`](../type-aliases/type-alias.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/class.OrderPurchaseUpdateRequest.md b/release/fraudPreventionV2/docs/models/classes/class.OrderPurchaseUpdateRequest.md deleted file mode 100644 index 753db4c5..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.OrderPurchaseUpdateRequest.md +++ /dev/null @@ -1,39 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > OrderPurchaseUpdateRequest - -# Class: OrderPurchaseUpdateRequest - -The `type` field value is used as a discriminator, with the following mapping: _ `ORDER_UPDATE`: `OrderUpdate` _ `CHARGEBACK_FEEDBACK`: `ChargebackFeedback` _ `INSULT_FEEDBACK`: `InsultFeedback` _ `REFUND_UPDATE`: `RefundUpdate` \* `PAYMENT_UPDATE`: `PaymentUpdate` - -## Extended By - -- [`ChargebackFeedback`](class.ChargebackFeedback.md) -- [`InsultFeedback`](class.InsultFeedback.md) -- [`OrderUpdate`](class.OrderUpdate.md) -- [`PaymentUpdate`](class.PaymentUpdate.md) -- [`RefundUpdate`](class.RefundUpdate.md) - -## Constructors - -### constructor() - -> **new OrderPurchaseUpdateRequest**(`orderPurchaseUpdateRequest`): [`OrderPurchaseUpdateRequest`](class.OrderPurchaseUpdateRequest.md) - -#### Parameters - -| Parameter | Type | -| :--------------------------- | :-------------------------------------------------------------------------------------------------------- | -| `orderPurchaseUpdateRequest` | [`OrderPurchaseUpdateRequestProperties`](../interfaces/interface.OrderPurchaseUpdateRequestProperties.md) | - -#### Returns - -[`OrderPurchaseUpdateRequest`](class.OrderPurchaseUpdateRequest.md) - -#### Source - -models/OrderPurchaseUpdateRequest.ts:34 - -## Properties - -| 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/class.OrderPurchaseUpdateResponse.md b/release/fraudPreventionV2/docs/models/classes/class.OrderPurchaseUpdateResponse.md deleted file mode 100644 index 334adaea..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.OrderPurchaseUpdateResponse.md +++ /dev/null @@ -1,29 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > OrderPurchaseUpdateResponse - -# Class: OrderPurchaseUpdateResponse - -## Constructors - -### constructor() - -> **new OrderPurchaseUpdateResponse**(`orderPurchaseUpdateResponse`): [`OrderPurchaseUpdateResponse`](class.OrderPurchaseUpdateResponse.md) - -#### Parameters - -| Parameter | Type | -| :---------------------------- | :---------------------------------------------------------------------------------------------------------- | -| `orderPurchaseUpdateResponse` | [`OrderPurchaseUpdateResponseProperties`](../interfaces/interface.OrderPurchaseUpdateResponseProperties.md) | - -#### Returns - -[`OrderPurchaseUpdateResponse`](class.OrderPurchaseUpdateResponse.md) - -#### Source - -models/OrderPurchaseUpdateResponse.ts:31 - -## Properties - -| Property | Type | Description | -| :-------- | :------- | :------------------------------------------------- | -| `riskId`? | `string` | Unique identifier of transaction that was updated. | diff --git a/release/fraudPreventionV2/docs/models/classes/class.OrderUpdate.md b/release/fraudPreventionV2/docs/models/classes/class.OrderUpdate.md deleted file mode 100644 index e5baeb4a..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.OrderUpdate.md +++ /dev/null @@ -1,43 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > OrderUpdate - -# Class: OrderUpdate - -Order related data that should be updated. - -## Extends - -- [`OrderPurchaseUpdateRequest`](class.OrderPurchaseUpdateRequest.md) - -## Constructors - -### constructor() - -> **new OrderUpdate**(`orderUpdate`): [`OrderUpdate`](class.OrderUpdate.md) - -#### Parameters - -| Parameter | Type | -| :------------ | :-------------------------------------------------------------------------- | -| `orderUpdate` | [`OrderUpdateProperties`](../interfaces/interface.OrderUpdateProperties.md) | - -#### Returns - -[`OrderUpdate`](class.OrderUpdate.md) - -#### Overrides - -[`OrderPurchaseUpdateRequest`](class.OrderPurchaseUpdateRequest.md).[`constructor`](class.OrderPurchaseUpdateRequest.md#constructor) - -#### Source - -models/OrderUpdate.ts:50 - -## Properties - -| 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. `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`? | [`CancellationReason`](class.CancellationReason.md) | - | -| `orderStatus` | [`Status`](../type-aliases/type-alias.Status.md) | - | -| `riskId` | `string` | The `risk_id` provided by Expedia\'s Fraud Prevention Service in the `OrderPurchaseScreenResponse`. | -| `readonly` `type` | `"ORDER_UPDATE"` | - | diff --git a/release/fraudPreventionV2/docs/models/classes/class.PayPal.md b/release/fraudPreventionV2/docs/models/classes/class.PayPal.md deleted file mode 100644 index eb3f81d0..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.PayPal.md +++ /dev/null @@ -1,51 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > PayPal - -# Class: PayPal - -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` - -## Extends - -- [`Payment`](class.Payment.md) - -## Constructors - -### constructor() - -> **new PayPal**(`payPal`): [`PayPal`](class.PayPal.md) - -#### Parameters - -| Parameter | Type | -| :-------- | :---------------------------------------------------------------- | -| `payPal` | [`PayPalProperties`](../interfaces/interface.PayPalProperties.md) | - -#### Returns - -[`PayPal`](class.PayPal.md) - -#### Overrides - -[`Payment`](class.Payment.md).[`constructor`](class.Payment.md#constructor) - -#### Source - -models/PayPal.ts:46 - -## Properties - -| Property | Type | Description | -| :--------------------------- | :------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `authorizedAmount`? | [`Amount`](class.Amount.md) | - | -| `billingAddress` | [`PaymentBillingAddress`](class.PaymentBillingAddress.md) | - | -| `billingEmailAddress` | `string` | Email address associated with the payment. | -| `billingName` | [`Name`](class.Name.md) | - | -| `brand` | [`PaymentBrandEnum`](../type-aliases/type-alias.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` _ `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` | -| `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. | -| `readonly` `method` | `"PAYPAL"` | - | -| `operations`? | [`Operations`](class.Operations.md) | - | -| `payerId` | `string` | Unique PayPal Customer Account identification number. | -| `reason`? | [`PaymentReason`](../type-aliases/type-alias.PaymentReason.md) | - | -| `threeDigitsSecureCriteria`? | [`PaymentThreeDSCriteria`](class.PaymentThreeDSCriteria.md) | - | -| `transactionId` | `string` | Unique transaction number to identify Auth calls at PayPal. | -| `verifiedAmount`? | [`Amount`](class.Amount.md) | - | diff --git a/release/fraudPreventionV2/docs/models/classes/class.Payment.md b/release/fraudPreventionV2/docs/models/classes/class.Payment.md deleted file mode 100644 index d9577c1f..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.Payment.md +++ /dev/null @@ -1,48 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > Payment - -# Class: Payment - -The `method` field value is used as a discriminator, with the following mapping: _ `CREDIT_CARD`: `CreditCard` _ `PAYPAL`: `PayPal` _ `POINTS`: `Points` _ `GIFT_CARD`: `GiftCard` _ `INTERNET_BANK_PAYMENT`: `InternetBankPayment` _ `DIRECT_DEBIT`: `DirectDebit` - -## Extended By - -- [`CreditCard`](class.CreditCard.md) -- [`DirectDebit`](class.DirectDebit.md) -- [`GiftCard`](class.GiftCard.md) -- [`InternetBankPayment`](class.InternetBankPayment.md) -- [`PayPal`](class.PayPal.md) -- [`Points`](class.Points.md) - -## Constructors - -### constructor() - -> **new Payment**(`payment`): [`Payment`](class.Payment.md) - -#### Parameters - -| Parameter | Type | -| :-------- | :------------------------------------------------------------------ | -| `payment` | [`PaymentProperties`](../interfaces/interface.PaymentProperties.md) | - -#### Returns - -[`Payment`](class.Payment.md) - -#### Source - -models/Payment.ts:87 - -## Properties - -| Property | Type | Description | -| :--------------------------- | :------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `authorizedAmount`? | [`Amount`](class.Amount.md) | - | -| `billingAddress` | [`PaymentBillingAddress`](class.PaymentBillingAddress.md) | - | -| `billingEmailAddress` | `string` | Email address associated with the payment. | -| `billingName` | [`Name`](class.Name.md) | - | -| `brand` | [`PaymentBrandEnum`](../type-aliases/type-alias.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` _ `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` | -| `operations`? | [`Operations`](class.Operations.md) | - | -| `reason`? | [`PaymentReason`](../type-aliases/type-alias.PaymentReason.md) | - | -| `threeDigitsSecureCriteria`? | [`PaymentThreeDSCriteria`](class.PaymentThreeDSCriteria.md) | - | -| `verifiedAmount`? | [`Amount`](class.Amount.md) | - | diff --git a/release/fraudPreventionV2/docs/models/classes/class.PaymentBillingAddress.md b/release/fraudPreventionV2/docs/models/classes/class.PaymentBillingAddress.md deleted file mode 100644 index 91cab5c6..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.PaymentBillingAddress.md +++ /dev/null @@ -1,35 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > PaymentBillingAddress - -# Class: PaymentBillingAddress - -## Constructors - -### constructor() - -> **new PaymentBillingAddress**(`paymentBillingAddress`): [`PaymentBillingAddress`](class.PaymentBillingAddress.md) - -#### Parameters - -| Parameter | Type | -| :---------------------- | :---------------------------------------------------------------------------------------------- | -| `paymentBillingAddress` | [`PaymentBillingAddressProperties`](../interfaces/interface.PaymentBillingAddressProperties.md) | - -#### Returns - -[`PaymentBillingAddress`](class.PaymentBillingAddress.md) - -#### Source - -models/PaymentBillingAddress.ts:58 - -## Properties - -| 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/type-alias.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/class.PaymentOperation.md b/release/fraudPreventionV2/docs/models/classes/class.PaymentOperation.md deleted file mode 100644 index d90979c4..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.PaymentOperation.md +++ /dev/null @@ -1,31 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > PaymentOperation - -# Class: PaymentOperation - -## Constructors - -### constructor() - -> **new PaymentOperation**(`paymentOperation`): [`PaymentOperation`](class.PaymentOperation.md) - -#### Parameters - -| Parameter | Type | -| :----------------- | :------------------------------------------------------------------------------------ | -| `paymentOperation` | [`PaymentOperationProperties`](../interfaces/interface.PaymentOperationProperties.md) | - -#### Returns - -[`PaymentOperation`](class.PaymentOperation.md) - -#### Source - -models/PaymentOperation.ts:44 - -## Properties - -| Property | Type | -| :--------- | :------------------------------------------ | -| `amount`? | [`Amount`](class.Amount.md) | -| `id`? | `string` | -| `outcome`? | [`PaymentOutcome`](class.PaymentOutcome.md) | diff --git a/release/fraudPreventionV2/docs/models/classes/class.PaymentOutcome.md b/release/fraudPreventionV2/docs/models/classes/class.PaymentOutcome.md deleted file mode 100644 index 4cbcc3dc..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.PaymentOutcome.md +++ /dev/null @@ -1,31 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > PaymentOutcome - -# Class: PaymentOutcome - -## Constructors - -### constructor() - -> **new PaymentOutcome**(`paymentOutcome`): [`PaymentOutcome`](class.PaymentOutcome.md) - -#### Parameters - -| Parameter | Type | -| :--------------- | :-------------------------------------------------------------------------------- | -| `paymentOutcome` | [`PaymentOutcomeProperties`](../interfaces/interface.PaymentOutcomeProperties.md) | - -#### Returns - -[`PaymentOutcome`](class.PaymentOutcome.md) - -#### Source - -models/PaymentOutcome.ts:39 - -## Properties - -| 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/type-alias.PaymentStatus.md) | - | diff --git a/release/fraudPreventionV2/docs/models/classes/class.PaymentThreeDSCriteria.md b/release/fraudPreventionV2/docs/models/classes/class.PaymentThreeDSCriteria.md deleted file mode 100644 index 1860d05e..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.PaymentThreeDSCriteria.md +++ /dev/null @@ -1,32 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > PaymentThreeDSCriteria - -# Class: PaymentThreeDSCriteria - -Payment ThreeDS criteria attributes. - -## Constructors - -### constructor() - -> **new PaymentThreeDSCriteria**(`paymentThreeDSCriteria`): [`PaymentThreeDSCriteria`](class.PaymentThreeDSCriteria.md) - -#### Parameters - -| Parameter | Type | -| :----------------------- | :------------------------------------------------------------------------------------------------ | -| `paymentThreeDSCriteria` | [`PaymentThreeDSCriteriaProperties`](../interfaces/interface.PaymentThreeDSCriteriaProperties.md) | - -#### Returns - -[`PaymentThreeDSCriteria`](class.PaymentThreeDSCriteria.md) - -#### Source - -models/PaymentThreeDSCriteria.ts:39 - -## Properties - -| 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/class.PaymentUpdate.md b/release/fraudPreventionV2/docs/models/classes/class.PaymentUpdate.md deleted file mode 100644 index 28f672dc..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.PaymentUpdate.md +++ /dev/null @@ -1,41 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > PaymentUpdate - -# Class: PaymentUpdate - -Payment related data that should be updated. - -## Extends - -- [`OrderPurchaseUpdateRequest`](class.OrderPurchaseUpdateRequest.md) - -## Constructors - -### constructor() - -> **new PaymentUpdate**(`paymentUpdate`): [`PaymentUpdate`](class.PaymentUpdate.md) - -#### Parameters - -| Parameter | Type | -| :-------------- | :------------------------------------------------------------------------------ | -| `paymentUpdate` | [`PaymentUpdateProperties`](../interfaces/interface.PaymentUpdateProperties.md) | - -#### Returns - -[`PaymentUpdate`](class.PaymentUpdate.md) - -#### Overrides - -[`OrderPurchaseUpdateRequest`](class.OrderPurchaseUpdateRequest.md).[`constructor`](class.OrderPurchaseUpdateRequest.md#constructor) - -#### Source - -models/PaymentUpdate.ts:39 - -## Properties - -| Property | Type | Description | -| :------------------ | :----------------- | :-------------------------------------------------------------------------------------------------------------------------------------------- | -| `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. | -| `riskId` | `string` | The `risk_id` provided by Expedia\'s Fraud Prevention Service in the `OrderPurchaseScreenResponse`. | -| `readonly` `type` | `"PAYMENT_UPDATE"` | - | diff --git a/release/fraudPreventionV2/docs/models/classes/class.Points.md b/release/fraudPreventionV2/docs/models/classes/class.Points.md deleted file mode 100644 index 3b3291c0..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.Points.md +++ /dev/null @@ -1,49 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > Points - -# Class: Points - -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` - -## Extends - -- [`Payment`](class.Payment.md) - -## Constructors - -### constructor() - -> **new Points**(`points`): [`Points`](class.Points.md) - -#### Parameters - -| Parameter | Type | -| :-------- | :---------------------------------------------------------------- | -| `points` | [`PointsProperties`](../interfaces/interface.PointsProperties.md) | - -#### Returns - -[`Points`](class.Points.md) - -#### Overrides - -[`Payment`](class.Payment.md).[`constructor`](class.Payment.md#constructor) - -#### Source - -models/Points.ts:36 - -## Properties - -| Property | Type | Description | -| :--------------------------- | :------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `accountId` | `string` | Points account id. | -| `authorizedAmount`? | [`Amount`](class.Amount.md) | - | -| `billingAddress` | [`PaymentBillingAddress`](class.PaymentBillingAddress.md) | - | -| `billingEmailAddress` | `string` | Email address associated with the payment. | -| `billingName` | [`Name`](class.Name.md) | - | -| `brand` | [`PaymentBrandEnum`](../type-aliases/type-alias.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` _ `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` | -| `readonly` `method` | `"POINTS"` | - | -| `operations`? | [`Operations`](class.Operations.md) | - | -| `reason`? | [`PaymentReason`](../type-aliases/type-alias.PaymentReason.md) | - | -| `threeDigitsSecureCriteria`? | [`PaymentThreeDSCriteria`](class.PaymentThreeDSCriteria.md) | - | -| `verifiedAmount`? | [`Amount`](class.Amount.md) | - | diff --git a/release/fraudPreventionV2/docs/models/classes/class.Rail.md b/release/fraudPreventionV2/docs/models/classes/class.Rail.md deleted file mode 100644 index b18bfb6a..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.Rail.md +++ /dev/null @@ -1,46 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > Rail - -# Class: Rail - -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` - -## Extends - -- [`TravelProduct`](class.TravelProduct.md) - -## Constructors - -### constructor() - -> **new Rail**(`rail`): [`Rail`](class.Rail.md) - -#### Parameters - -| Parameter | Type | -| :-------- | :------------------------------------------------------------ | -| `rail` | [`RailProperties`](../interfaces/interface.RailProperties.md) | - -#### Returns - -[`Rail`](class.Rail.md) - -#### Overrides - -[`TravelProduct`](class.TravelProduct.md).[`constructor`](class.TravelProduct.md#constructor) - -#### Source - -models/Rail.ts:44 - -## Properties - -| Property | Type | Description | -| :--------------------- | :--------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `inventorySource` | [`TravelProductInventorySourceEnum`](../type-aliases/type-alias.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`](class.Amount.md) | - | -| `railSegments` | [`RailSegments`](class.RailSegments.md)[] | - | -| `routeType` | [`RailRouteTypeEnum`](../type-aliases/type-alias.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`? | `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. | -| `readonly` `type` | `"RAIL"` | - | diff --git a/release/fraudPreventionV2/docs/models/classes/class.RailSegments.md b/release/fraudPreventionV2/docs/models/classes/class.RailSegments.md deleted file mode 100644 index 80daf4ec..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.RailSegments.md +++ /dev/null @@ -1,34 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > RailSegments - -# Class: RailSegments - -## Constructors - -### constructor() - -> **new RailSegments**(`railSegments`): [`RailSegments`](class.RailSegments.md) - -#### Parameters - -| Parameter | Type | -| :------------- | :---------------------------------------------------------------------------- | -| `railSegments` | [`RailSegmentsProperties`](../interfaces/interface.RailSegmentsProperties.md) | - -#### Returns - -[`RailSegments`](class.RailSegments.md) - -#### Source - -models/RailSegments.ts:63 - -## Properties - -| Property | Type | Description | -| :--------------------- | :----------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `arrivalStation` | [`RailwayStationDetails`](class.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`](class.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`](class.RailSegmentsOperatingCompany.md) | - | -| `transportationMethod` | [`RailSegmentsTransportationMethodEnum`](../type-aliases/type-alias.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/class.RailSegmentsOperatingCompany.md b/release/fraudPreventionV2/docs/models/classes/class.RailSegmentsOperatingCompany.md deleted file mode 100644 index 7b3a842f..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.RailSegmentsOperatingCompany.md +++ /dev/null @@ -1,31 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > RailSegmentsOperatingCompany - -# Class: RailSegmentsOperatingCompany - -This attribute captures the name or identifier of the company responsible for operating the Rail product. It represents the specific operating entity, such as Amtrak, British Railways, or a bus company. - -## Constructors - -### constructor() - -> **new RailSegmentsOperatingCompany**(`railSegmentsOperatingCompany`): [`RailSegmentsOperatingCompany`](class.RailSegmentsOperatingCompany.md) - -#### Parameters - -| Parameter | Type | -| :----------------------------- | :------------------------------------------------------------------------------------------------------------ | -| `railSegmentsOperatingCompany` | [`RailSegmentsOperatingCompanyProperties`](../interfaces/interface.RailSegmentsOperatingCompanyProperties.md) | - -#### Returns - -[`RailSegmentsOperatingCompany`](class.RailSegmentsOperatingCompany.md) - -#### Source - -models/RailSegmentsOperatingCompany.ts:34 - -## Properties - -| 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/class.RailwayStationDetails.md b/release/fraudPreventionV2/docs/models/classes/class.RailwayStationDetails.md deleted file mode 100644 index 4b142e1d..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.RailwayStationDetails.md +++ /dev/null @@ -1,33 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > RailwayStationDetails - -# Class: RailwayStationDetails - -## Constructors - -### constructor() - -> **new RailwayStationDetails**(`railwayStationDetails`): [`RailwayStationDetails`](class.RailwayStationDetails.md) - -#### Parameters - -| Parameter | Type | -| :---------------------- | :---------------------------------------------------------------------------------------------- | -| `railwayStationDetails` | [`RailwayStationDetailsProperties`](../interfaces/interface.RailwayStationDetailsProperties.md) | - -#### Returns - -[`RailwayStationDetails`](class.RailwayStationDetails.md) - -#### Source - -models/RailwayStationDetails.ts:54 - -## Properties - -| Property | Type | Description | -| :------------ | :--------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `address` | [`CustomerAccountAddress`](class.CustomerAccountAddress.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/type-alias.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/class.Refund.md b/release/fraudPreventionV2/docs/models/classes/class.Refund.md deleted file mode 100644 index 11da7e02..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.Refund.md +++ /dev/null @@ -1,33 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > Refund - -# Class: Refund - -Refund operation on the payment. A refund operation represents the intent to refund a previous charge. - -## Constructors - -### constructor() - -> **new Refund**(`refund`): [`Refund`](class.Refund.md) - -#### Parameters - -| Parameter | Type | -| :-------- | :---------------------------------------------------------------- | -| `refund` | [`RefundProperties`](../interfaces/interface.RefundProperties.md) | - -#### Returns - -[`Refund`](class.Refund.md) - -#### Source - -models/Refund.ts:47 - -## Properties - -| Property | Type | -| :--------- | :------------------------------------------ | -| `amount`? | [`Amount`](class.Amount.md) | -| `id`? | `string` | -| `outcome`? | [`PaymentOutcome`](class.PaymentOutcome.md) | diff --git a/release/fraudPreventionV2/docs/models/classes/class.RefundUpdate.md b/release/fraudPreventionV2/docs/models/classes/class.RefundUpdate.md deleted file mode 100644 index c8eab970..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.RefundUpdate.md +++ /dev/null @@ -1,40 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > RefundUpdate - -# Class: RefundUpdate - -Refund related data. Update should be sent when refund is issued or settled. Amounts should include all fees and taxes. - -## Extends - -- [`OrderPurchaseUpdateRequest`](class.OrderPurchaseUpdateRequest.md) - -## Constructors - -### constructor() - -> **new RefundUpdate**(`refundUpdate`): [`RefundUpdate`](class.RefundUpdate.md) - -#### Parameters - -| Parameter | Type | -| :------------- | :---------------------------------------------------------------------------- | -| `refundUpdate` | [`RefundUpdateProperties`](../interfaces/interface.RefundUpdateProperties.md) | - -#### Returns - -[`RefundUpdate`](class.RefundUpdate.md) - -#### Overrides - -[`OrderPurchaseUpdateRequest`](class.OrderPurchaseUpdateRequest.md).[`constructor`](class.OrderPurchaseUpdateRequest.md#constructor) - -#### Source - -models/RefundUpdate.ts:33 - -## Properties - -| Property | Type | Description | -| :---------------- | :---------------- | :-------------------------------------------------------------------------------------------------- | -| `riskId` | `string` | The `risk_id` provided by Expedia\'s Fraud Prevention Service in the `OrderPurchaseScreenResponse`. | -| `readonly` `type` | `"REFUND_UPDATE"` | - | diff --git a/release/fraudPreventionV2/docs/models/classes/class.RemediationUpdate.md b/release/fraudPreventionV2/docs/models/classes/class.RemediationUpdate.md deleted file mode 100644 index 4ffa9c7f..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.RemediationUpdate.md +++ /dev/null @@ -1,41 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > RemediationUpdate - -# Class: RemediationUpdate - -Information specific to remediation actions initiated by the Partner\'s system to a user as a result of a fraud recommendation. - -## Extends - -- [`AccountUpdateRequest`](class.AccountUpdateRequest.md) - -## Constructors - -### constructor() - -> **new RemediationUpdate**(`remediationUpdate`): [`RemediationUpdate`](class.RemediationUpdate.md) - -#### Parameters - -| Parameter | Type | -| :------------------ | :-------------------------------------------------------------------------------------- | -| `remediationUpdate` | [`RemediationUpdateProperties`](../interfaces/interface.RemediationUpdateProperties.md) | - -#### Returns - -[`RemediationUpdate`](class.RemediationUpdate.md) - -#### Overrides - -[`AccountUpdateRequest`](class.AccountUpdateRequest.md).[`constructor`](class.AccountUpdateRequest.md#constructor) - -#### Source - -models/RemediationUpdate.ts:42 - -## Properties - -| Property | Type | Description | -| :------------------------- | :-------------------------------------------------------------- | :-------------------------------------------------------------------------------------------- | -| `remediationUpdateActions` | [`RemediationUpdateAction`](class.RemediationUpdateAction.md)[] | - | -| `riskId` | `string` | The `risk_id` provided by Expedia\'s Fraud Prevention Service in the `AccountScreenResponse`. | -| `readonly` `type` | `"REMEDIATION_UPDATE"` | - | diff --git a/release/fraudPreventionV2/docs/models/classes/class.RemediationUpdateAction.md b/release/fraudPreventionV2/docs/models/classes/class.RemediationUpdateAction.md deleted file mode 100644 index 3e058b2d..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.RemediationUpdateAction.md +++ /dev/null @@ -1,33 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > RemediationUpdateAction - -# Class: RemediationUpdateAction - -Information specific to the remediation action initiated by the Partner\'s system to a user. - -## Constructors - -### constructor() - -> **new RemediationUpdateAction**(`remediationUpdateAction`): [`RemediationUpdateAction`](class.RemediationUpdateAction.md) - -#### Parameters - -| Parameter | Type | -| :------------------------ | :-------------------------------------------------------------------------------------------------- | -| `remediationUpdateAction` | [`RemediationUpdateActionProperties`](../interfaces/interface.RemediationUpdateActionProperties.md) | - -#### Returns - -[`RemediationUpdateAction`](class.RemediationUpdateAction.md) - -#### Source - -models/RemediationUpdateAction.ts:44 - -## Properties - -| Property | Type | Description | -| :------------------- | :------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `actionName` | [`RemediationUpdateActionActionNameEnum`](../type-aliases/type-alias.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/type-alias.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/class.RetryableOrderPurchaseScreenFailure.md b/release/fraudPreventionV2/docs/models/classes/class.RetryableOrderPurchaseScreenFailure.md deleted file mode 100644 index 9095731e..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.RetryableOrderPurchaseScreenFailure.md +++ /dev/null @@ -1,32 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > RetryableOrderPurchaseScreenFailure - -# 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 \.\" - -## Constructors - -### constructor() - -> **new RetryableOrderPurchaseScreenFailure**(`retryableOrderPurchaseScreenFailure`): [`RetryableOrderPurchaseScreenFailure`](class.RetryableOrderPurchaseScreenFailure.md) - -#### Parameters - -| Parameter | Type | -| :------------------------------------ | :-------------------------------------------------------------------------------------------------------------------------- | -| `retryableOrderPurchaseScreenFailure` | [`RetryableOrderPurchaseScreenFailureProperties`](../interfaces/interface.RetryableOrderPurchaseScreenFailureProperties.md) | - -#### Returns - -[`RetryableOrderPurchaseScreenFailure`](class.RetryableOrderPurchaseScreenFailure.md) - -#### Source - -models/RetryableOrderPurchaseScreenFailure.ts:39 - -## Properties - -| Property | Type | Description | -| :-------- | :------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------- | -| `code` | [`RetryableOrderPurchaseScreenFailureCodeEnum`](../type-aliases/type-alias.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/class.RetryableOrderPurchaseUpdateFailure.md b/release/fraudPreventionV2/docs/models/classes/class.RetryableOrderPurchaseUpdateFailure.md deleted file mode 100644 index 612d1320..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.RetryableOrderPurchaseUpdateFailure.md +++ /dev/null @@ -1,32 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > RetryableOrderPurchaseUpdateFailure - -# 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 \.\" - -## Constructors - -### constructor() - -> **new RetryableOrderPurchaseUpdateFailure**(`retryableOrderPurchaseUpdateFailure`): [`RetryableOrderPurchaseUpdateFailure`](class.RetryableOrderPurchaseUpdateFailure.md) - -#### Parameters - -| Parameter | Type | -| :------------------------------------ | :-------------------------------------------------------------------------------------------------------------------------- | -| `retryableOrderPurchaseUpdateFailure` | [`RetryableOrderPurchaseUpdateFailureProperties`](../interfaces/interface.RetryableOrderPurchaseUpdateFailureProperties.md) | - -#### Returns - -[`RetryableOrderPurchaseUpdateFailure`](class.RetryableOrderPurchaseUpdateFailure.md) - -#### Source - -models/RetryableOrderPurchaseUpdateFailure.ts:39 - -## Properties - -| Property | Type | Description | -| :-------- | :------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------- | -| `code` | [`RetryableOrderPurchaseUpdateFailureCodeEnum`](../type-aliases/type-alias.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/class.ServiceUnavailableError.md b/release/fraudPreventionV2/docs/models/classes/class.ServiceUnavailableError.md deleted file mode 100644 index d175325c..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.ServiceUnavailableError.md +++ /dev/null @@ -1,32 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > ServiceUnavailableError - -# 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 \.\" - -## Constructors - -### constructor() - -> **new ServiceUnavailableError**(`serviceUnavailableError`): [`ServiceUnavailableError`](class.ServiceUnavailableError.md) - -#### Parameters - -| Parameter | Type | -| :------------------------ | :-------------------------------------------------------------------------------------------------- | -| `serviceUnavailableError` | [`ServiceUnavailableErrorProperties`](../interfaces/interface.ServiceUnavailableErrorProperties.md) | - -#### Returns - -[`ServiceUnavailableError`](class.ServiceUnavailableError.md) - -#### Source - -models/ServiceUnavailableError.ts:39 - -## Properties - -| Property | Type | Description | -| :-------- | :------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------- | -| `code` | [`ServiceUnavailableErrorCodeEnum`](../type-aliases/type-alias.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/class.SettledRefundUpdate.md b/release/fraudPreventionV2/docs/models/classes/class.SettledRefundUpdate.md deleted file mode 100644 index bb7b409d..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.SettledRefundUpdate.md +++ /dev/null @@ -1,42 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > SettledRefundUpdate - -# Class: SettledRefundUpdate - -Data related to the settled refund that should be updated. - -## Extends - -- [`RefundUpdate`](class.RefundUpdate.md) - -## Constructors - -### constructor() - -> **new SettledRefundUpdate**(`settledRefundUpdate`): [`SettledRefundUpdate`](class.SettledRefundUpdate.md) - -#### Parameters - -| Parameter | Type | -| :-------------------- | :------------------------------------------------------------------------------------------ | -| `settledRefundUpdate` | [`SettledRefundUpdateProperties`](../interfaces/interface.SettledRefundUpdateProperties.md) | - -#### Returns - -[`SettledRefundUpdate`](class.SettledRefundUpdate.md) - -#### Overrides - -[`RefundUpdate`](class.RefundUpdate.md).[`constructor`](class.RefundUpdate.md#constructor) - -#### Source - -models/SettledRefundUpdate.ts:41 - -## Properties - -| Property | Type | Description | -| :------------------------ | :------------------------------------------------------------------ | :-------------------------------------------------------------------------------------------------- | -| `refundDetails`? | [`SettledRefundUpdateDetails`](class.SettledRefundUpdateDetails.md) | - | -| `readonly` `refundStatus` | `"SETTLED"` | - | -| `riskId` | `string` | The `risk_id` provided by Expedia\'s Fraud Prevention Service in the `OrderPurchaseScreenResponse`. | -| `readonly` `type` | `"REFUND_UPDATE"` | - | diff --git a/release/fraudPreventionV2/docs/models/classes/class.SettledRefundUpdateDetails.md b/release/fraudPreventionV2/docs/models/classes/class.SettledRefundUpdateDetails.md deleted file mode 100644 index e63b7f02..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.SettledRefundUpdateDetails.md +++ /dev/null @@ -1,35 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > SettledRefundUpdateDetails - -# Class: SettledRefundUpdateDetails - -Data that describes settled refund that should be updated. - -## Constructors - -### constructor() - -> **new SettledRefundUpdateDetails**(`settledRefundUpdateDetails`): [`SettledRefundUpdateDetails`](class.SettledRefundUpdateDetails.md) - -#### Parameters - -| Parameter | Type | -| :--------------------------- | :-------------------------------------------------------------------------------------------------------- | -| `settledRefundUpdateDetails` | [`SettledRefundUpdateDetailsProperties`](../interfaces/interface.SettledRefundUpdateDetailsProperties.md) | - -#### Returns - -[`SettledRefundUpdateDetails`](class.SettledRefundUpdateDetails.md) - -#### Source - -models/SettledRefundUpdateDetails.ts:57 - -## Properties - -| 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`](class.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/class.SiteInfo.md b/release/fraudPreventionV2/docs/models/classes/class.SiteInfo.md deleted file mode 100644 index 170fce2d..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.SiteInfo.md +++ /dev/null @@ -1,30 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > SiteInfo - -# Class: SiteInfo - -## Constructors - -### constructor() - -> **new SiteInfo**(`siteInfo`): [`SiteInfo`](class.SiteInfo.md) - -#### Parameters - -| Parameter | Type | -| :--------- | :-------------------------------------------------------------------- | -| `siteInfo` | [`SiteInfoProperties`](../interfaces/interface.SiteInfoProperties.md) | - -#### Returns - -[`SiteInfo`](class.SiteInfo.md) - -#### Source - -models/SiteInfo.ts:36 - -## Properties - -| 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/class.Telephone.md b/release/fraudPreventionV2/docs/models/classes/class.Telephone.md deleted file mode 100644 index 93289d59..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.Telephone.md +++ /dev/null @@ -1,39 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > Telephone - -# Class: Telephone - -Group of attributes intended to hold information about phone number associated with the transaction. A user can have one to many phone numbers (home, work, mobile, etc.). - -## Constructors - -### constructor() - -> **new Telephone**(`telephone`): [`Telephone`](class.Telephone.md) - -#### Parameters - -| Parameter | Type | -| :---------- | :---------------------------------------------------------------------- | -| `telephone` | [`TelephoneProperties`](../interfaces/interface.TelephoneProperties.md) | - -#### Returns - -[`Telephone`](class.Telephone.md) - -#### Source - -models/Telephone.ts:70 - -## Properties - -| 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/type-alias.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/type-alias.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/class.TooManyRequestsError.md b/release/fraudPreventionV2/docs/models/classes/class.TooManyRequestsError.md deleted file mode 100644 index 25d0dda2..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.TooManyRequestsError.md +++ /dev/null @@ -1,32 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > TooManyRequestsError - -# 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. - -## Constructors - -### constructor() - -> **new TooManyRequestsError**(`tooManyRequestsError`): [`TooManyRequestsError`](class.TooManyRequestsError.md) - -#### Parameters - -| Parameter | Type | -| :--------------------- | :-------------------------------------------------------------------------------------------- | -| `tooManyRequestsError` | [`TooManyRequestsErrorProperties`](../interfaces/interface.TooManyRequestsErrorProperties.md) | - -#### Returns - -[`TooManyRequestsError`](class.TooManyRequestsError.md) - -#### Source - -models/TooManyRequestsError.ts:39 - -## Properties - -| Property | Type | Description | -| :-------- | :------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------- | -| `code` | [`TooManyRequestsErrorCodeEnum`](../type-aliases/type-alias.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/class.TransactionDetails.md b/release/fraudPreventionV2/docs/models/classes/class.TransactionDetails.md deleted file mode 100644 index 5c58bcf4..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.TransactionDetails.md +++ /dev/null @@ -1,34 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > TransactionDetails - -# Class: TransactionDetails - -## Constructors - -### constructor() - -> **new TransactionDetails**(`transactionDetails`): [`TransactionDetails`](class.TransactionDetails.md) - -#### Parameters - -| Parameter | Type | -| :------------------- | :---------------------------------------------------------------------------------------- | -| `transactionDetails` | [`TransactionDetailsProperties`](../interfaces/interface.TransactionDetailsProperties.md) | - -#### Returns - -[`TransactionDetails`](class.TransactionDetails.md) - -#### Source - -models/TransactionDetails.ts:71 - -## Properties - -| Property | Type | Description | -| :------------------- | :------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `currentOrderStatus` | [`TransactionDetailsCurrentOrderStatusEnum`](../type-aliases/type-alias.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/type-alias.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`](class.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`](class.TravelProduct.md)[] | - | -| `travelers` | [`Traveler`](class.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/class.TravelProduct.md b/release/fraudPreventionV2/docs/models/classes/class.TravelProduct.md deleted file mode 100644 index 58322c69..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.TravelProduct.md +++ /dev/null @@ -1,44 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > TravelProduct - -# Class: TravelProduct - -The `type` field value is used as a discriminator, with the following mapping: _ `CRUISE`: `Cruise` _ `AIR`: `Air` _ `CAR`: `Car` _ `INSURANCE`: `Insurance` _ `HOTEL`: `Hotel` _ `RAIL`: `Rail` - -## Extended By - -- [`Air`](class.Air.md) -- [`Car`](class.Car.md) -- [`Cruise`](class.Cruise.md) -- [`Hotel`](class.Hotel.md) -- [`Insurance`](class.Insurance.md) -- [`Rail`](class.Rail.md) - -## Constructors - -### constructor() - -> **new TravelProduct**(`travelProduct`): [`TravelProduct`](class.TravelProduct.md) - -#### Parameters - -| Parameter | Type | -| :-------------- | :------------------------------------------------------------------------------ | -| `travelProduct` | [`TravelProductProperties`](../interfaces/interface.TravelProductProperties.md) | - -#### Returns - -[`TravelProduct`](class.TravelProduct.md) - -#### Source - -models/TravelProduct.ts:56 - -## Properties - -| Property | Type | Description | -| :--------------------- | :--------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `inventorySource` | [`TravelProductInventorySourceEnum`](../type-aliases/type-alias.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`](class.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/class.Traveler.md b/release/fraudPreventionV2/docs/models/classes/class.Traveler.md deleted file mode 100644 index cb3cf111..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.Traveler.md +++ /dev/null @@ -1,36 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > Traveler - -# Class: Traveler - -## Constructors - -### constructor() - -> **new Traveler**(`traveler`): [`Traveler`](class.Traveler.md) - -#### Parameters - -| Parameter | Type | -| :--------- | :-------------------------------------------------------------------- | -| `traveler` | [`TravelerProperties`](../interfaces/interface.TravelerProperties.md) | - -#### Returns - -[`Traveler`](class.Traveler.md) - -#### Source - -models/Traveler.ts:71 - -## Properties - -| 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`](class.Telephone.md)[] | - | -| `travelerId`? | `string` | A unique identifier for travelers in the transaction. | -| `travelerName` | [`Name`](class.Name.md) | - | diff --git a/release/fraudPreventionV2/docs/models/classes/class.UnauthorizedError.md b/release/fraudPreventionV2/docs/models/classes/class.UnauthorizedError.md deleted file mode 100644 index 6d22deba..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.UnauthorizedError.md +++ /dev/null @@ -1,32 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > UnauthorizedError - -# Class: UnauthorizedError - -Indicates that the token sent in the \'Authorization\' header is either invalid or missing. Please check the value in the token field along with the token expiration time before retrying. - -## Constructors - -### constructor() - -> **new UnauthorizedError**(`unauthorizedError`): [`UnauthorizedError`](class.UnauthorizedError.md) - -#### Parameters - -| Parameter | Type | -| :------------------ | :-------------------------------------------------------------------------------------- | -| `unauthorizedError` | [`UnauthorizedErrorProperties`](../interfaces/interface.UnauthorizedErrorProperties.md) | - -#### Returns - -[`UnauthorizedError`](class.UnauthorizedError.md) - -#### Source - -models/UnauthorizedError.ts:39 - -## Properties - -| Property | Type | Description | -| :-------- | :------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------- | -| `code` | [`UnauthorizedErrorCodeEnum`](../type-aliases/type-alias.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/class.Verify.md b/release/fraudPreventionV2/docs/models/classes/class.Verify.md deleted file mode 100644 index 21623571..00000000 --- a/release/fraudPreventionV2/docs/models/classes/class.Verify.md +++ /dev/null @@ -1,34 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > Verify - -# Class: Verify - -A verify operation represents the intent to verify the payment associated with this transaction. - -## Constructors - -### constructor() - -> **new Verify**(`verify`): [`Verify`](class.Verify.md) - -#### Parameters - -| Parameter | Type | -| :-------- | :---------------------------------------------------------------- | -| `verify` | [`VerifyProperties`](../interfaces/interface.VerifyProperties.md) | - -#### Returns - -[`Verify`](class.Verify.md) - -#### Source - -models/Verify.ts:50 - -## Properties - -| Property | Type | -| :--------- | :------------------------------------------------------------------- | -| `amount`? | [`Amount`](class.Amount.md) | -| `id`? | `string` | -| `outcome`? | [`PaymentOutcome`](class.PaymentOutcome.md) | -| `type`? | [`VerificationType`](../type-aliases/type-alias.VerificationType.md) | diff --git a/release/fraudPreventionV2/docs/models/core/classes/class.AxiosClientConfigurations.md b/release/fraudPreventionV2/docs/models/core/classes/class.AxiosClientConfigurations.md deleted file mode 100644 index ba1a91db..00000000 --- a/release/fraudPreventionV2/docs/models/core/classes/class.AxiosClientConfigurations.md +++ /dev/null @@ -1,31 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../../index.md) > [models](../../index.md) > [core](../index.md) > AxiosClientConfigurations - -# Class: AxiosClientConfigurations - -## Constructors - -### constructor() - -> **new AxiosClientConfigurations**(`endpoint` = `Constant.ENDPOINT`, `requestTimeout` = `Constant.TEN_SECONDS_IN_MILLIS`): [`AxiosClientConfigurations`](class.AxiosClientConfigurations.md) - -#### Parameters - -| Parameter | Type | Default value | -| :--------------- | :------- | :------------------------------- | -| `endpoint` | `string` | `Constant.ENDPOINT` | -| `requestTimeout` | `number` | `Constant.TEN_SECONDS_IN_MILLIS` | - -#### Returns - -[`AxiosClientConfigurations`](class.AxiosClientConfigurations.md) - -#### Source - -core/src/client/AxiosClientConfigurations.ts:24 - -## Properties - -| Property | Type | -| :-------------------------- | :------- | -| `readonly` `endpoint` | `string` | -| `readonly` `requestTimeout` | `number` | diff --git a/release/fraudPreventionV2/docs/models/core/index.md b/release/fraudPreventionV2/docs/models/core/index.md deleted file mode 100644 index 1cd63d39..00000000 --- a/release/fraudPreventionV2/docs/models/core/index.md +++ /dev/null @@ -1,14 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > core - -# Module: core - -## Index - -### Classes - -- [AxiosClientConfigurations](classes/class.AxiosClientConfigurations.md) -- [Client](classes/class.Client.md) - -### Interfaces - -- [ClientConfigurations](interfaces/interface.ClientConfigurations.md) diff --git a/release/fraudPreventionV2/docs/models/core/interfaces/interface.ClientConfigurations.md b/release/fraudPreventionV2/docs/models/core/interfaces/interface.ClientConfigurations.md deleted file mode 100644 index 7c6c75c6..00000000 --- a/release/fraudPreventionV2/docs/models/core/interfaces/interface.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 | -| :---------------- | :------- | -| `authEndpoint`? | `string` | -| `endpoint`? | `string` | -| `key` | `string` | -| `requestTimeout`? | `number` | -| `secret` | `string` | diff --git a/release/fraudPreventionV2/docs/models/index.md b/release/fraudPreventionV2/docs/models/index.md deleted file mode 100644 index e91c684a..00000000 --- a/release/fraudPreventionV2/docs/models/index.md +++ /dev/null @@ -1,269 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../index.md) > models - -# Module: models - -## Index - -### Modules - -- [core](core/index.md) - -### Classes - -- [AccountScreenRequest](classes/class.AccountScreenRequest.md) -- [AccountScreenResponse](classes/class.AccountScreenResponse.md) -- [AccountTakeoverBadRequestError](classes/class.AccountTakeoverBadRequestError.md) -- [AccountTakeoverBadRequestErrorAllOfCauses](classes/class.AccountTakeoverBadRequestErrorAllOfCauses.md) -- [AccountTakeoverCustomerAccount](classes/class.AccountTakeoverCustomerAccount.md) -- [AccountTakeoverDeviceDetails](classes/class.AccountTakeoverDeviceDetails.md) -- [AccountTakeoverError](classes/class.AccountTakeoverError.md) -- [AccountTakeoverName](classes/class.AccountTakeoverName.md) -- [AccountTakeoverSiteInfo](classes/class.AccountTakeoverSiteInfo.md) -- [AccountTakeoverTransactionDetails](classes/class.AccountTakeoverTransactionDetails.md) -- [AccountTakeoverUnauthorizedError](classes/class.AccountTakeoverUnauthorizedError.md) -- [AccountTransaction](classes/class.AccountTransaction.md) -- [AccountUpdateNotFoundError](classes/class.AccountUpdateNotFoundError.md) -- [AccountUpdateRequest](classes/class.AccountUpdateRequest.md) -- [AccountUpdateResponse](classes/class.AccountUpdateResponse.md) -- [Address](classes/class.Address.md) -- [Air](classes/class.Air.md) -- [AirSegment](classes/class.AirSegment.md) -- [Amount](classes/class.Amount.md) -- [Authorize](classes/class.Authorize.md) -- [AuthorizeReversal](classes/class.AuthorizeReversal.md) -- [BadGatewayError](classes/class.BadGatewayError.md) -- [BadRequestError](classes/class.BadRequestError.md) -- [BadRequestErrorAllOfCauses](classes/class.BadRequestErrorAllOfCauses.md) -- [CancellationReason](classes/class.CancellationReason.md) -- [Capture](classes/class.Capture.md) -- [Car](classes/class.Car.md) -- [ChallengeDetail](classes/class.ChallengeDetail.md) -- [ChargebackDetail](classes/class.ChargebackDetail.md) -- [ChargebackFeedback](classes/class.ChargebackFeedback.md) -- [CreditCard](classes/class.CreditCard.md) -- [Cruise](classes/class.Cruise.md) -- [CurrentUserSession](classes/class.CurrentUserSession.md) -- [CustomerAccount](classes/class.CustomerAccount.md) -- [CustomerAccountAddress](classes/class.CustomerAccountAddress.md) -- [DeviceDetails](classes/class.DeviceDetails.md) -- [DirectDebit](classes/class.DirectDebit.md) -- [Email](classes/class.Email.md) -- [ForbiddenError](classes/class.ForbiddenError.md) -- [GatewayTimeoutError](classes/class.GatewayTimeoutError.md) -- [GiftCard](classes/class.GiftCard.md) -- [Hotel](classes/class.Hotel.md) -- [HotelAddress](classes/class.HotelAddress.md) -- [HotelAllOfAddress](classes/class.HotelAllOfAddress.md) -- [InsultDetail](classes/class.InsultDetail.md) -- [InsultFeedback](classes/class.InsultFeedback.md) -- [Insurance](classes/class.Insurance.md) -- [InternalServerError](classes/class.InternalServerError.md) -- [InternetBankPayment](classes/class.InternetBankPayment.md) -- [IssuedRefundUpdate](classes/class.IssuedRefundUpdate.md) -- [IssuedRefundUpdateDetails](classes/class.IssuedRefundUpdateDetails.md) -- [LoginTransactionDetails](classes/class.LoginTransactionDetails.md) -- [ModelError](classes/class.ModelError.md) -- [MultiFactorAuthenticationAttempt](classes/class.MultiFactorAuthenticationAttempt.md) -- [MultiFactorAuthenticationUpdate](classes/class.MultiFactorAuthenticationUpdate.md) -- [Name](classes/class.Name.md) -- [NotFoundError](classes/class.NotFoundError.md) -- [Operations](classes/class.Operations.md) -- [OrderPurchaseScreenRequest](classes/class.OrderPurchaseScreenRequest.md) -- [OrderPurchaseScreenResponse](classes/class.OrderPurchaseScreenResponse.md) -- [OrderPurchaseTransaction](classes/class.OrderPurchaseTransaction.md) -- [OrderPurchaseUpdateNotFoundError](classes/class.OrderPurchaseUpdateNotFoundError.md) -- [OrderPurchaseUpdateRequest](classes/class.OrderPurchaseUpdateRequest.md) -- [OrderPurchaseUpdateResponse](classes/class.OrderPurchaseUpdateResponse.md) -- [OrderUpdate](classes/class.OrderUpdate.md) -- [PayPal](classes/class.PayPal.md) -- [Payment](classes/class.Payment.md) -- [PaymentBillingAddress](classes/class.PaymentBillingAddress.md) -- [PaymentOperation](classes/class.PaymentOperation.md) -- [PaymentOutcome](classes/class.PaymentOutcome.md) -- [PaymentThreeDSCriteria](classes/class.PaymentThreeDSCriteria.md) -- [PaymentUpdate](classes/class.PaymentUpdate.md) -- [Points](classes/class.Points.md) -- [Rail](classes/class.Rail.md) -- [RailSegments](classes/class.RailSegments.md) -- [RailSegmentsOperatingCompany](classes/class.RailSegmentsOperatingCompany.md) -- [RailwayStationDetails](classes/class.RailwayStationDetails.md) -- [Refund](classes/class.Refund.md) -- [RefundUpdate](classes/class.RefundUpdate.md) -- [RemediationUpdate](classes/class.RemediationUpdate.md) -- [RemediationUpdateAction](classes/class.RemediationUpdateAction.md) -- [RetryableOrderPurchaseScreenFailure](classes/class.RetryableOrderPurchaseScreenFailure.md) -- [RetryableOrderPurchaseUpdateFailure](classes/class.RetryableOrderPurchaseUpdateFailure.md) -- [ServiceUnavailableError](classes/class.ServiceUnavailableError.md) -- [SettledRefundUpdate](classes/class.SettledRefundUpdate.md) -- [SettledRefundUpdateDetails](classes/class.SettledRefundUpdateDetails.md) -- [SiteInfo](classes/class.SiteInfo.md) -- [Telephone](classes/class.Telephone.md) -- [TooManyRequestsError](classes/class.TooManyRequestsError.md) -- [TransactionDetails](classes/class.TransactionDetails.md) -- [TravelProduct](classes/class.TravelProduct.md) -- [Traveler](classes/class.Traveler.md) -- [UnauthorizedError](classes/class.UnauthorizedError.md) -- [Verify](classes/class.Verify.md) - -### Interfaces - -- [AccountScreenRequestProperties](interfaces/interface.AccountScreenRequestProperties.md) -- [AccountScreenResponseProperties](interfaces/interface.AccountScreenResponseProperties.md) -- [AccountTakeoverBadRequestErrorAllOfCausesProperties](interfaces/interface.AccountTakeoverBadRequestErrorAllOfCausesProperties.md) -- [AccountTakeoverBadRequestErrorProperties](interfaces/interface.AccountTakeoverBadRequestErrorProperties.md) -- [AccountTakeoverCustomerAccountProperties](interfaces/interface.AccountTakeoverCustomerAccountProperties.md) -- [AccountTakeoverDeviceDetailsProperties](interfaces/interface.AccountTakeoverDeviceDetailsProperties.md) -- [AccountTakeoverErrorProperties](interfaces/interface.AccountTakeoverErrorProperties.md) -- [AccountTakeoverNameProperties](interfaces/interface.AccountTakeoverNameProperties.md) -- [AccountTakeoverSiteInfoProperties](interfaces/interface.AccountTakeoverSiteInfoProperties.md) -- [AccountTakeoverTransactionDetailsProperties](interfaces/interface.AccountTakeoverTransactionDetailsProperties.md) -- [AccountTakeoverUnauthorizedErrorProperties](interfaces/interface.AccountTakeoverUnauthorizedErrorProperties.md) -- [AccountTransactionProperties](interfaces/interface.AccountTransactionProperties.md) -- [AccountUpdateNotFoundErrorProperties](interfaces/interface.AccountUpdateNotFoundErrorProperties.md) -- [AccountUpdateRequestProperties](interfaces/interface.AccountUpdateRequestProperties.md) -- [AccountUpdateResponseProperties](interfaces/interface.AccountUpdateResponseProperties.md) -- [AddressProperties](interfaces/interface.AddressProperties.md) -- [AirProperties](interfaces/interface.AirProperties.md) -- [AirSegmentProperties](interfaces/interface.AirSegmentProperties.md) -- [AmountProperties](interfaces/interface.AmountProperties.md) -- [AuthorizeProperties](interfaces/interface.AuthorizeProperties.md) -- [AuthorizeReversalProperties](interfaces/interface.AuthorizeReversalProperties.md) -- [BadGatewayErrorProperties](interfaces/interface.BadGatewayErrorProperties.md) -- [BadRequestErrorAllOfCausesProperties](interfaces/interface.BadRequestErrorAllOfCausesProperties.md) -- [BadRequestErrorProperties](interfaces/interface.BadRequestErrorProperties.md) -- [CancellationReasonProperties](interfaces/interface.CancellationReasonProperties.md) -- [CaptureProperties](interfaces/interface.CaptureProperties.md) -- [CarProperties](interfaces/interface.CarProperties.md) -- [ChallengeDetailProperties](interfaces/interface.ChallengeDetailProperties.md) -- [ChargebackDetailProperties](interfaces/interface.ChargebackDetailProperties.md) -- [ChargebackFeedbackProperties](interfaces/interface.ChargebackFeedbackProperties.md) -- [CreditCardProperties](interfaces/interface.CreditCardProperties.md) -- [CruiseProperties](interfaces/interface.CruiseProperties.md) -- [CurrentUserSessionProperties](interfaces/interface.CurrentUserSessionProperties.md) -- [CustomerAccountAddressProperties](interfaces/interface.CustomerAccountAddressProperties.md) -- [CustomerAccountProperties](interfaces/interface.CustomerAccountProperties.md) -- [DeviceDetailsProperties](interfaces/interface.DeviceDetailsProperties.md) -- [DirectDebitProperties](interfaces/interface.DirectDebitProperties.md) -- [EmailProperties](interfaces/interface.EmailProperties.md) -- [ForbiddenErrorProperties](interfaces/interface.ForbiddenErrorProperties.md) -- [GatewayTimeoutErrorProperties](interfaces/interface.GatewayTimeoutErrorProperties.md) -- [GiftCardProperties](interfaces/interface.GiftCardProperties.md) -- [HotelAddressProperties](interfaces/interface.HotelAddressProperties.md) -- [HotelAllOfAddressProperties](interfaces/interface.HotelAllOfAddressProperties.md) -- [HotelProperties](interfaces/interface.HotelProperties.md) -- [InsultDetailProperties](interfaces/interface.InsultDetailProperties.md) -- [InsultFeedbackProperties](interfaces/interface.InsultFeedbackProperties.md) -- [InsuranceProperties](interfaces/interface.InsuranceProperties.md) -- [InternalServerErrorProperties](interfaces/interface.InternalServerErrorProperties.md) -- [InternetBankPaymentProperties](interfaces/interface.InternetBankPaymentProperties.md) -- [IssuedRefundUpdateDetailsProperties](interfaces/interface.IssuedRefundUpdateDetailsProperties.md) -- [IssuedRefundUpdateProperties](interfaces/interface.IssuedRefundUpdateProperties.md) -- [LoginTransactionDetailsProperties](interfaces/interface.LoginTransactionDetailsProperties.md) -- [ModelErrorProperties](interfaces/interface.ModelErrorProperties.md) -- [MultiFactorAuthenticationAttemptProperties](interfaces/interface.MultiFactorAuthenticationAttemptProperties.md) -- [MultiFactorAuthenticationUpdateProperties](interfaces/interface.MultiFactorAuthenticationUpdateProperties.md) -- [NameProperties](interfaces/interface.NameProperties.md) -- [NotFoundErrorProperties](interfaces/interface.NotFoundErrorProperties.md) -- [OperationsProperties](interfaces/interface.OperationsProperties.md) -- [OrderPurchaseScreenRequestProperties](interfaces/interface.OrderPurchaseScreenRequestProperties.md) -- [OrderPurchaseScreenResponseProperties](interfaces/interface.OrderPurchaseScreenResponseProperties.md) -- [OrderPurchaseTransactionProperties](interfaces/interface.OrderPurchaseTransactionProperties.md) -- [OrderPurchaseUpdateNotFoundErrorProperties](interfaces/interface.OrderPurchaseUpdateNotFoundErrorProperties.md) -- [OrderPurchaseUpdateRequestProperties](interfaces/interface.OrderPurchaseUpdateRequestProperties.md) -- [OrderPurchaseUpdateResponseProperties](interfaces/interface.OrderPurchaseUpdateResponseProperties.md) -- [OrderUpdateProperties](interfaces/interface.OrderUpdateProperties.md) -- [PayPalProperties](interfaces/interface.PayPalProperties.md) -- [PaymentBillingAddressProperties](interfaces/interface.PaymentBillingAddressProperties.md) -- [PaymentOperationProperties](interfaces/interface.PaymentOperationProperties.md) -- [PaymentOutcomeProperties](interfaces/interface.PaymentOutcomeProperties.md) -- [PaymentProperties](interfaces/interface.PaymentProperties.md) -- [PaymentThreeDSCriteriaProperties](interfaces/interface.PaymentThreeDSCriteriaProperties.md) -- [PaymentUpdateProperties](interfaces/interface.PaymentUpdateProperties.md) -- [PointsProperties](interfaces/interface.PointsProperties.md) -- [RailProperties](interfaces/interface.RailProperties.md) -- [RailSegmentsOperatingCompanyProperties](interfaces/interface.RailSegmentsOperatingCompanyProperties.md) -- [RailSegmentsProperties](interfaces/interface.RailSegmentsProperties.md) -- [RailwayStationDetailsProperties](interfaces/interface.RailwayStationDetailsProperties.md) -- [RefundProperties](interfaces/interface.RefundProperties.md) -- [RefundUpdateProperties](interfaces/interface.RefundUpdateProperties.md) -- [RemediationUpdateActionProperties](interfaces/interface.RemediationUpdateActionProperties.md) -- [RemediationUpdateProperties](interfaces/interface.RemediationUpdateProperties.md) -- [RetryableOrderPurchaseScreenFailureProperties](interfaces/interface.RetryableOrderPurchaseScreenFailureProperties.md) -- [RetryableOrderPurchaseUpdateFailureProperties](interfaces/interface.RetryableOrderPurchaseUpdateFailureProperties.md) -- [ServiceUnavailableErrorProperties](interfaces/interface.ServiceUnavailableErrorProperties.md) -- [SettledRefundUpdateDetailsProperties](interfaces/interface.SettledRefundUpdateDetailsProperties.md) -- [SettledRefundUpdateProperties](interfaces/interface.SettledRefundUpdateProperties.md) -- [SiteInfoProperties](interfaces/interface.SiteInfoProperties.md) -- [TelephoneProperties](interfaces/interface.TelephoneProperties.md) -- [TooManyRequestsErrorProperties](interfaces/interface.TooManyRequestsErrorProperties.md) -- [TransactionDetailsProperties](interfaces/interface.TransactionDetailsProperties.md) -- [TravelProductProperties](interfaces/interface.TravelProductProperties.md) -- [TravelerProperties](interfaces/interface.TravelerProperties.md) -- [UnauthorizedErrorProperties](interfaces/interface.UnauthorizedErrorProperties.md) -- [VerifyProperties](interfaces/interface.VerifyProperties.md) - -### Type Aliases - -- [AccountTakeoverBadRequestErrorAllOfCausesCodeEnum](type-aliases/type-alias.AccountTakeoverBadRequestErrorAllOfCausesCodeEnum.md) -- [AccountTakeoverBadRequestErrorCodeEnum](type-aliases/type-alias.AccountTakeoverBadRequestErrorCodeEnum.md) -- [AccountTakeoverCustomerAccountAccountRoleEnum](type-aliases/type-alias.AccountTakeoverCustomerAccountAccountRoleEnum.md) -- [AccountTakeoverCustomerAccountAccountTypeEnum](type-aliases/type-alias.AccountTakeoverCustomerAccountAccountTypeEnum.md) -- [AccountTakeoverDeviceDetailsTypeEnum](type-aliases/type-alias.AccountTakeoverDeviceDetailsTypeEnum.md) -- [AccountTakeoverErrorCodeEnum](type-aliases/type-alias.AccountTakeoverErrorCodeEnum.md) -- [AccountTakeoverFraudDecision](type-aliases/type-alias.AccountTakeoverFraudDecision.md) -- [AccountTakeoverSiteInfoPlacementNameEnum](type-aliases/type-alias.AccountTakeoverSiteInfoPlacementNameEnum.md) -- [AccountTakeoverTransactionDetailsTypeEnum](type-aliases/type-alias.AccountTakeoverTransactionDetailsTypeEnum.md) -- [AccountTakeoverUnauthorizedErrorCodeEnum](type-aliases/type-alias.AccountTakeoverUnauthorizedErrorCodeEnum.md) -- [AccountUpdateNotFoundErrorCodeEnum](type-aliases/type-alias.AccountUpdateNotFoundErrorCodeEnum.md) -- [AccountUpdateRequestTypeEnum](type-aliases/type-alias.AccountUpdateRequestTypeEnum.md) -- [AddressAddressTypeEnum](type-aliases/type-alias.AddressAddressTypeEnum.md) -- [AirFlightTypeEnum](type-aliases/type-alias.AirFlightTypeEnum.md) -- [BadGatewayErrorCodeEnum](type-aliases/type-alias.BadGatewayErrorCodeEnum.md) -- [BadRequestErrorAllOfCausesCodeEnum](type-aliases/type-alias.BadRequestErrorAllOfCausesCodeEnum.md) -- [BadRequestErrorCodeEnum](type-aliases/type-alias.BadRequestErrorCodeEnum.md) -- [ChallengeDetailStatusEnum](type-aliases/type-alias.ChallengeDetailStatusEnum.md) -- [ChallengeDetailTypeEnum](type-aliases/type-alias.ChallengeDetailTypeEnum.md) -- [ChargebackDetailChargebackReasonEnum](type-aliases/type-alias.ChargebackDetailChargebackReasonEnum.md) -- [ChargebackDetailChargebackStatusEnum](type-aliases/type-alias.ChargebackDetailChargebackStatusEnum.md) -- [CreditCardCardTypeEnum](type-aliases/type-alias.CreditCardCardTypeEnum.md) -- [CustomerAccountAccountTypeEnum](type-aliases/type-alias.CustomerAccountAccountTypeEnum.md) -- [CustomerAccountAddressAddressTypeEnum](type-aliases/type-alias.CustomerAccountAddressAddressTypeEnum.md) -- [ForbiddenErrorCodeEnum](type-aliases/type-alias.ForbiddenErrorCodeEnum.md) -- [FraudDecision](type-aliases/type-alias.FraudDecision.md) -- [GatewayTimeoutErrorCodeEnum](type-aliases/type-alias.GatewayTimeoutErrorCodeEnum.md) -- [HotelAddressAddressTypeEnum](type-aliases/type-alias.HotelAddressAddressTypeEnum.md) -- [HotelAllOfAddressAddressTypeEnum](type-aliases/type-alias.HotelAllOfAddressAddressTypeEnum.md) -- [InternalServerErrorCodeEnum](type-aliases/type-alias.InternalServerErrorCodeEnum.md) -- [LoginTransactionDetailsAuthenticationSubTypeEnum](type-aliases/type-alias.LoginTransactionDetailsAuthenticationSubTypeEnum.md) -- [LoginTransactionDetailsAuthenticationTypeEnum](type-aliases/type-alias.LoginTransactionDetailsAuthenticationTypeEnum.md) -- [LoginTransactionDetailsFailedLoginReasonEnum](type-aliases/type-alias.LoginTransactionDetailsFailedLoginReasonEnum.md) -- [ModelErrorCodeEnum](type-aliases/type-alias.ModelErrorCodeEnum.md) -- [MultiFactorAuthenticationAttemptDeliveryMethodEnum](type-aliases/type-alias.MultiFactorAuthenticationAttemptDeliveryMethodEnum.md) -- [MultiFactorAuthenticationAttemptStatusEnum](type-aliases/type-alias.MultiFactorAuthenticationAttemptStatusEnum.md) -- [NotFoundErrorCodeEnum](type-aliases/type-alias.NotFoundErrorCodeEnum.md) -- [OrderPurchaseUpdateNotFoundErrorCodeEnum](type-aliases/type-alias.OrderPurchaseUpdateNotFoundErrorCodeEnum.md) -- [PaymentBillingAddressAddressTypeEnum](type-aliases/type-alias.PaymentBillingAddressAddressTypeEnum.md) -- [PaymentBrandEnum](type-aliases/type-alias.PaymentBrandEnum.md) -- [PaymentMethod](type-aliases/type-alias.PaymentMethod.md) -- [PaymentReason](type-aliases/type-alias.PaymentReason.md) -- [PaymentStatus](type-aliases/type-alias.PaymentStatus.md) -- [RailRouteTypeEnum](type-aliases/type-alias.RailRouteTypeEnum.md) -- [RailSegmentsTransportationMethodEnum](type-aliases/type-alias.RailSegmentsTransportationMethodEnum.md) -- [RailwayStationDetailsTypeEnum](type-aliases/type-alias.RailwayStationDetailsTypeEnum.md) -- [RefundUpdateRefundStatusEnum](type-aliases/type-alias.RefundUpdateRefundStatusEnum.md) -- [RemediationUpdateActionActionNameEnum](type-aliases/type-alias.RemediationUpdateActionActionNameEnum.md) -- [RemediationUpdateActionStatusEnum](type-aliases/type-alias.RemediationUpdateActionStatusEnum.md) -- [RetryableOrderPurchaseScreenFailureCodeEnum](type-aliases/type-alias.RetryableOrderPurchaseScreenFailureCodeEnum.md) -- [RetryableOrderPurchaseUpdateFailureCodeEnum](type-aliases/type-alias.RetryableOrderPurchaseUpdateFailureCodeEnum.md) -- [ServiceUnavailableErrorCodeEnum](type-aliases/type-alias.ServiceUnavailableErrorCodeEnum.md) -- [Status](type-aliases/type-alias.Status.md) -- [TelephonePlatformType](type-aliases/type-alias.TelephonePlatformType.md) -- [TelephoneType](type-aliases/type-alias.TelephoneType.md) -- [TooManyRequestsErrorCodeEnum](type-aliases/type-alias.TooManyRequestsErrorCodeEnum.md) -- [TransactionDetailsCurrentOrderStatusEnum](type-aliases/type-alias.TransactionDetailsCurrentOrderStatusEnum.md) -- [TransactionDetailsOrderTypeEnum](type-aliases/type-alias.TransactionDetailsOrderTypeEnum.md) -- [TravelProductInventorySourceEnum](type-aliases/type-alias.TravelProductInventorySourceEnum.md) -- [TravelProductType](type-aliases/type-alias.TravelProductType.md) -- [UnauthorizedErrorCodeEnum](type-aliases/type-alias.UnauthorizedErrorCodeEnum.md) -- [UpdateType](type-aliases/type-alias.UpdateType.md) -- [VerificationType](type-aliases/type-alias.VerificationType.md) diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.AccountScreenRequestProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.AccountScreenRequestProperties.md deleted file mode 100644 index 79f55c77..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.AccountScreenRequestProperties.md +++ /dev/null @@ -1,9 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountScreenRequestProperties - -# Interface: AccountScreenRequestProperties - -## Properties - -| Property | Type | -| :------------ | :------------------------------------------------------------- | -| `transaction` | [`AccountTransaction`](../classes/class.AccountTransaction.md) | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.AccountScreenResponseProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.AccountScreenResponseProperties.md deleted file mode 100644 index 9c9f6c9a..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.AccountScreenResponseProperties.md +++ /dev/null @@ -1,10 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountScreenResponseProperties - -# Interface: AccountScreenResponseProperties - -## Properties - -| Property | Type | -| :---------- | :------------------------------------------------------------------------------------------- | -| `decision`? | [`AccountTakeoverFraudDecision`](../type-aliases/type-alias.AccountTakeoverFraudDecision.md) | -| `riskId`? | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.AccountTakeoverBadRequestErrorAllOfCausesProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.AccountTakeoverBadRequestErrorAllOfCausesProperties.md deleted file mode 100644 index b817b493..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.AccountTakeoverBadRequestErrorAllOfCausesProperties.md +++ /dev/null @@ -1,11 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountTakeoverBadRequestErrorAllOfCausesProperties - -# Interface: AccountTakeoverBadRequestErrorAllOfCausesProperties - -## Properties - -| Property | Type | -| :--------- | :------------------------------------------------------------------------------------------------------------------------------------- | -| `code`? | [`AccountTakeoverBadRequestErrorAllOfCausesCodeEnum`](../type-aliases/type-alias.AccountTakeoverBadRequestErrorAllOfCausesCodeEnum.md) | -| `field`? | `string` | -| `message`? | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.AccountTakeoverBadRequestErrorProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.AccountTakeoverBadRequestErrorProperties.md deleted file mode 100644 index 7a28d133..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.AccountTakeoverBadRequestErrorProperties.md +++ /dev/null @@ -1,11 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountTakeoverBadRequestErrorProperties - -# Interface: AccountTakeoverBadRequestErrorProperties - -## Properties - -| Property | Type | -| :-------- | :--------------------------------------------------------------------------------------------------------------- | -| `causes`? | [`AccountTakeoverBadRequestErrorAllOfCauses`](../classes/class.AccountTakeoverBadRequestErrorAllOfCauses.md)[] | -| `code` | [`AccountTakeoverBadRequestErrorCodeEnum`](../type-aliases/type-alias.AccountTakeoverBadRequestErrorCodeEnum.md) | -| `message` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.AccountTakeoverCustomerAccountProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.AccountTakeoverCustomerAccountProperties.md deleted file mode 100644 index c8d1ad16..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.AccountTakeoverCustomerAccountProperties.md +++ /dev/null @@ -1,19 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountTakeoverCustomerAccountProperties - -# Interface: AccountTakeoverCustomerAccountProperties - -## Properties - -| Property | Type | -| :----------------- | :----------------------------------------------------------------------------------------------------------------------------- | -| `accountRole`? | [`AccountTakeoverCustomerAccountAccountRoleEnum`](../type-aliases/type-alias.AccountTakeoverCustomerAccountAccountRoleEnum.md) | -| `accountType` | [`AccountTakeoverCustomerAccountAccountTypeEnum`](../type-aliases/type-alias.AccountTakeoverCustomerAccountAccountTypeEnum.md) | -| `activeFlag` | `boolean` | -| `address`? | [`CustomerAccountAddress`](../classes/class.CustomerAccountAddress.md) | -| `emailAddress` | `string` | -| `loyaltyMemberId`? | `string` | -| `name`? | [`AccountTakeoverName`](../classes/class.AccountTakeoverName.md) | -| `registeredTime` | `Date` | -| `telephones`? | [`Telephone`](../classes/class.Telephone.md)[] | -| `userId` | `string` | -| `username` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.AccountTakeoverDeviceDetailsProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.AccountTakeoverDeviceDetailsProperties.md deleted file mode 100644 index 255cd4b3..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.AccountTakeoverDeviceDetailsProperties.md +++ /dev/null @@ -1,13 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountTakeoverDeviceDetailsProperties - -# Interface: AccountTakeoverDeviceDetailsProperties - -## Properties - -| Property | Type | -| :---------- | :----------------------------------------------------------------------------------------------------------- | -| `deviceBox` | `string` | -| `ipAddress` | `string` | -| `source`? | `string` | -| `type`? | [`AccountTakeoverDeviceDetailsTypeEnum`](../type-aliases/type-alias.AccountTakeoverDeviceDetailsTypeEnum.md) | -| `userAgent` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.AccountTakeoverErrorProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.AccountTakeoverErrorProperties.md deleted file mode 100644 index 747e148a..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.AccountTakeoverErrorProperties.md +++ /dev/null @@ -1,10 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountTakeoverErrorProperties - -# Interface: AccountTakeoverErrorProperties - -## Properties - -| Property | Type | -| :-------- | :------------------------------------------------------------------------------------------- | -| `code` | [`AccountTakeoverErrorCodeEnum`](../type-aliases/type-alias.AccountTakeoverErrorCodeEnum.md) | -| `message` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.AccountTakeoverNameProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.AccountTakeoverNameProperties.md deleted file mode 100644 index be40496e..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.AccountTakeoverNameProperties.md +++ /dev/null @@ -1,13 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountTakeoverNameProperties - -# Interface: AccountTakeoverNameProperties - -## Properties - -| Property | Type | -| :------------ | :------- | -| `firstName` | `string` | -| `lastName` | `string` | -| `middleName`? | `string` | -| `suffix`? | `string` | -| `title`? | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.AccountTakeoverSiteInfoProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.AccountTakeoverSiteInfoProperties.md deleted file mode 100644 index 5e3ddf1a..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.AccountTakeoverSiteInfoProperties.md +++ /dev/null @@ -1,12 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountTakeoverSiteInfoProperties - -# Interface: AccountTakeoverSiteInfoProperties - -## Properties - -| Property | Type | -| :--------------- | :------------------------------------------------------------------------------------------------------------------- | -| `brandName` | `string` | -| `locale`? | `string` | -| `name`? | `string` | -| `placementName`? | [`AccountTakeoverSiteInfoPlacementNameEnum`](../type-aliases/type-alias.AccountTakeoverSiteInfoPlacementNameEnum.md) | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.AccountTakeoverTransactionDetailsProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.AccountTakeoverTransactionDetailsProperties.md deleted file mode 100644 index d3a0ce04..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.AccountTakeoverTransactionDetailsProperties.md +++ /dev/null @@ -1,15 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountTakeoverTransactionDetailsProperties - -# Interface: AccountTakeoverTransactionDetailsProperties - -## Extended By - -- [`LoginTransactionDetailsProperties`](interface.LoginTransactionDetailsProperties.md) - -## Properties - -| Property | Type | -| :-------------------- | :------------------------------------------------------------- | -| `currentUserSession`? | [`CurrentUserSession`](../classes/class.CurrentUserSession.md) | -| `transactionDateTime` | `Date` | -| `transactionId` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.AccountTakeoverUnauthorizedErrorProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.AccountTakeoverUnauthorizedErrorProperties.md deleted file mode 100644 index 6161c4d6..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.AccountTakeoverUnauthorizedErrorProperties.md +++ /dev/null @@ -1,10 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountTakeoverUnauthorizedErrorProperties - -# Interface: AccountTakeoverUnauthorizedErrorProperties - -## Properties - -| Property | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------- | -| `code` | [`AccountTakeoverUnauthorizedErrorCodeEnum`](../type-aliases/type-alias.AccountTakeoverUnauthorizedErrorCodeEnum.md) | -| `message` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.AccountTransactionProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.AccountTransactionProperties.md deleted file mode 100644 index ddf16b0d..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.AccountTransactionProperties.md +++ /dev/null @@ -1,12 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountTransactionProperties - -# Interface: AccountTransactionProperties - -## Properties - -| Property | Type | -| :------------------- | :------------------------------------------------------------------------------------------- | -| `customerAccount` | [`AccountTakeoverCustomerAccount`](../classes/class.AccountTakeoverCustomerAccount.md) | -| `deviceDetails` | [`AccountTakeoverDeviceDetails`](../classes/class.AccountTakeoverDeviceDetails.md) | -| `siteInfo` | [`AccountTakeoverSiteInfo`](../classes/class.AccountTakeoverSiteInfo.md) | -| `transactionDetails` | [`AccountTakeoverTransactionDetails`](../classes/class.AccountTakeoverTransactionDetails.md) | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.AccountUpdateNotFoundErrorProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.AccountUpdateNotFoundErrorProperties.md deleted file mode 100644 index 87804e9b..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.AccountUpdateNotFoundErrorProperties.md +++ /dev/null @@ -1,10 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountUpdateNotFoundErrorProperties - -# Interface: AccountUpdateNotFoundErrorProperties - -## Properties - -| Property | Type | -| :-------- | :------------------------------------------------------------------------------------------------------- | -| `code` | [`AccountUpdateNotFoundErrorCodeEnum`](../type-aliases/type-alias.AccountUpdateNotFoundErrorCodeEnum.md) | -| `message` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.AccountUpdateRequestProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.AccountUpdateRequestProperties.md deleted file mode 100644 index de40ab9b..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.AccountUpdateRequestProperties.md +++ /dev/null @@ -1,14 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountUpdateRequestProperties - -# Interface: AccountUpdateRequestProperties - -## Extended By - -- [`MultiFactorAuthenticationUpdateProperties`](interface.MultiFactorAuthenticationUpdateProperties.md) -- [`RemediationUpdateProperties`](interface.RemediationUpdateProperties.md) - -## Properties - -| Property | Type | -| :------- | :------- | -| `riskId` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.AddressProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.AddressProperties.md deleted file mode 100644 index 729399a0..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.AddressProperties.md +++ /dev/null @@ -1,15 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AddressProperties - -# Interface: AddressProperties - -## Properties - -| Property | Type | -| :-------------- | :------------------------------------------------------------------------------- | -| `addressLine1`? | `string` | -| `addressLine2`? | `string` | -| `addressType`? | [`AddressAddressTypeEnum`](../type-aliases/type-alias.AddressAddressTypeEnum.md) | -| `city`? | `string` | -| `countryCode`? | `string` | -| `state`? | `string` | -| `zipCode`? | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.AirProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.AirProperties.md deleted file mode 100644 index 13e88b69..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.AirProperties.md +++ /dev/null @@ -1,23 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AirProperties - -# Interface: AirProperties - -## Extends - -- [`TravelProductProperties`](interface.TravelProductProperties.md) - -## Properties - -| Property | Type | -| :------------------------------ | :--------------------------------------------------------------------------------------------------- | -| `airSegments` | [`AirSegment`](../classes/class.AirSegment.md)[] | -| `arrivalTime` | `Date` | -| `departureTime` | `Date` | -| `flightType`? | [`AirFlightTypeEnum`](../type-aliases/type-alias.AirFlightTypeEnum.md) | -| `globalDistributionSystemType`? | `string` | -| `inventorySource` | [`TravelProductInventorySourceEnum`](../type-aliases/type-alias.TravelProductInventorySourceEnum.md) | -| `inventoryType` | `string` | -| `passengerNameRecord`? | `string` | -| `payLater`? | `boolean` | -| `price` | [`Amount`](../classes/class.Amount.md) | -| `travelersReferences`? | `string`[] | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.AirSegmentProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.AirSegmentProperties.md deleted file mode 100644 index 5069f2bb..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.AirSegmentProperties.md +++ /dev/null @@ -1,13 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AirSegmentProperties - -# Interface: AirSegmentProperties - -## Properties - -| Property | Type | -| :--------------------- | :------- | -| `airlineCode` | `string` | -| `arrivalAirportCode` | `string` | -| `arrivalTime`? | `Date` | -| `departureAirportCode` | `string` | -| `departureTime`? | `Date` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.AmountProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.AmountProperties.md deleted file mode 100644 index c58cbfd6..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.AmountProperties.md +++ /dev/null @@ -1,10 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AmountProperties - -# Interface: AmountProperties - -## Properties - -| Property | Type | -| :------------- | :------- | -| `currencyCode` | `string` | -| `value` | `number` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.AuthorizeProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.AuthorizeProperties.md deleted file mode 100644 index f7d0ddfd..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.AuthorizeProperties.md +++ /dev/null @@ -1,11 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AuthorizeProperties - -# Interface: AuthorizeProperties - -## Properties - -| Property | Type | -| :--------- | :----------------------------------------------------- | -| `amount`? | [`Amount`](../classes/class.Amount.md) | -| `id`? | `string` | -| `outcome`? | [`PaymentOutcome`](../classes/class.PaymentOutcome.md) | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.AuthorizeReversalProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.AuthorizeReversalProperties.md deleted file mode 100644 index a88dc163..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.AuthorizeReversalProperties.md +++ /dev/null @@ -1,11 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AuthorizeReversalProperties - -# Interface: AuthorizeReversalProperties - -## Properties - -| Property | Type | -| :--------- | :----------------------------------------------------- | -| `amount`? | [`Amount`](../classes/class.Amount.md) | -| `id`? | `string` | -| `outcome`? | [`PaymentOutcome`](../classes/class.PaymentOutcome.md) | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.BadGatewayErrorProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.BadGatewayErrorProperties.md deleted file mode 100644 index ee971322..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.BadGatewayErrorProperties.md +++ /dev/null @@ -1,10 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > BadGatewayErrorProperties - -# Interface: BadGatewayErrorProperties - -## Properties - -| Property | Type | -| :-------- | :--------------------------------------------------------------------------------- | -| `code` | [`BadGatewayErrorCodeEnum`](../type-aliases/type-alias.BadGatewayErrorCodeEnum.md) | -| `message` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.BadRequestErrorAllOfCausesProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.BadRequestErrorAllOfCausesProperties.md deleted file mode 100644 index b773ce44..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.BadRequestErrorAllOfCausesProperties.md +++ /dev/null @@ -1,11 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > BadRequestErrorAllOfCausesProperties - -# Interface: BadRequestErrorAllOfCausesProperties - -## Properties - -| Property | Type | -| :--------- | :------------------------------------------------------------------------------------------------------- | -| `code`? | [`BadRequestErrorAllOfCausesCodeEnum`](../type-aliases/type-alias.BadRequestErrorAllOfCausesCodeEnum.md) | -| `field`? | `string` | -| `message`? | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.BadRequestErrorProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.BadRequestErrorProperties.md deleted file mode 100644 index 4bbe16da..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.BadRequestErrorProperties.md +++ /dev/null @@ -1,11 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > BadRequestErrorProperties - -# Interface: BadRequestErrorProperties - -## Properties - -| Property | Type | -| :-------- | :--------------------------------------------------------------------------------- | -| `causes`? | [`BadRequestErrorAllOfCauses`](../classes/class.BadRequestErrorAllOfCauses.md)[] | -| `code` | [`BadRequestErrorCodeEnum`](../type-aliases/type-alias.BadRequestErrorCodeEnum.md) | -| `message` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.CancellationReasonProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.CancellationReasonProperties.md deleted file mode 100644 index d0359cef..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.CancellationReasonProperties.md +++ /dev/null @@ -1,12 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > CancellationReasonProperties - -# Interface: CancellationReasonProperties - -## Properties - -| Property | Type | -| :-------------------------- | :------- | -| `primaryReasonCode`? | `string` | -| `primaryReasonDescription`? | `string` | -| `subReasonCode`? | `string` | -| `subReasonDescription`? | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.CaptureProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.CaptureProperties.md deleted file mode 100644 index 316d18d9..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.CaptureProperties.md +++ /dev/null @@ -1,11 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > CaptureProperties - -# Interface: CaptureProperties - -## Properties - -| Property | Type | -| :--------- | :----------------------------------------------------- | -| `amount`? | [`Amount`](../classes/class.Amount.md) | -| `id`? | `string` | -| `outcome`? | [`PaymentOutcome`](../classes/class.PaymentOutcome.md) | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.CarProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.CarProperties.md deleted file mode 100644 index beb1bfbc..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.CarProperties.md +++ /dev/null @@ -1,21 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > CarProperties - -# Interface: CarProperties - -## Extends - -- [`TravelProductProperties`](interface.TravelProductProperties.md) - -## Properties - -| Property | Type | -| :--------------------- | :--------------------------------------------------------------------------------------------------- | -| `dropOffLocation` | `string` | -| `inventorySource` | [`TravelProductInventorySourceEnum`](../type-aliases/type-alias.TravelProductInventorySourceEnum.md) | -| `inventoryType` | `string` | -| `payLater`? | `boolean` | -| `pickUpLocation` | `string` | -| `pickupTime` | `Date` | -| `price` | [`Amount`](../classes/class.Amount.md) | -| `returnTime` | `Date` | -| `travelersReferences`? | `string`[] | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.ChallengeDetailProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.ChallengeDetailProperties.md deleted file mode 100644 index 59b1b047..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.ChallengeDetailProperties.md +++ /dev/null @@ -1,11 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > ChallengeDetailProperties - -# Interface: ChallengeDetailProperties - -## Properties - -| Property | Type | -| :-------------- | :------------------------------------------------------------------------------------- | -| `displayedFlag` | `boolean` | -| `status` | [`ChallengeDetailStatusEnum`](../type-aliases/type-alias.ChallengeDetailStatusEnum.md) | -| `type` | [`ChallengeDetailTypeEnum`](../type-aliases/type-alias.ChallengeDetailTypeEnum.md) | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.ChargebackDetailProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.ChargebackDetailProperties.md deleted file mode 100644 index f3c18843..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.ChargebackDetailProperties.md +++ /dev/null @@ -1,13 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > ChargebackDetailProperties - -# Interface: ChargebackDetailProperties - -## Properties - -| Property | Type | -| :---------------------------- | :----------------------------------------------------------------------------------------------------------- | -| `bankReasonCode`? | `string` | -| `chargebackAmount` | [`Amount`](../classes/class.Amount.md) | -| `chargebackReason` | [`ChargebackDetailChargebackReasonEnum`](../type-aliases/type-alias.ChargebackDetailChargebackReasonEnum.md) | -| `chargebackReportedDateTime`? | `Date` | -| `chargebackStatus` | [`ChargebackDetailChargebackStatusEnum`](../type-aliases/type-alias.ChargebackDetailChargebackStatusEnum.md) | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.ChargebackFeedbackProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.ChargebackFeedbackProperties.md deleted file mode 100644 index 42e1d3d3..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.ChargebackFeedbackProperties.md +++ /dev/null @@ -1,14 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > ChargebackFeedbackProperties - -# Interface: ChargebackFeedbackProperties - -## Extends - -- [`OrderPurchaseUpdateRequestProperties`](interface.OrderPurchaseUpdateRequestProperties.md) - -## Properties - -| Property | Type | -| :------------------ | :--------------------------------------------------------- | -| `chargebackDetail`? | [`ChargebackDetail`](../classes/class.ChargebackDetail.md) | -| `riskId` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.CreditCardProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.CreditCardProperties.md deleted file mode 100644 index d6511db2..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.CreditCardProperties.md +++ /dev/null @@ -1,32 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > CreditCardProperties - -# Interface: CreditCardProperties - -## Extends - -- [`PaymentProperties`](interface.PaymentProperties.md) - -## Properties - -| Property | Type | -| :-------------------------------- | :------------------------------------------------------------------------------- | -| `authorizedAmount`? | [`Amount`](../classes/class.Amount.md) | -| `billingAddress` | [`PaymentBillingAddress`](../classes/class.PaymentBillingAddress.md) | -| `billingEmailAddress` | `string` | -| `billingName` | [`Name`](../classes/class.Name.md) | -| `brand` | [`PaymentBrandEnum`](../type-aliases/type-alias.PaymentBrandEnum.md) | -| `cardAuthenticationFailureCount`? | `number` | -| `cardAvsResponse`? | `string` | -| `cardCvvResponse`? | `string` | -| `cardNumber` | `string` | -| `cardType` | [`CreditCardCardTypeEnum`](../type-aliases/type-alias.CreditCardCardTypeEnum.md) | -| `electronicCommerceIndicator`? | `string` | -| `expiryDate` | `Date` | -| `merchantOrderCode`? | `string` | -| `operations`? | [`Operations`](../classes/class.Operations.md) | -| `reason`? | [`PaymentReason`](../type-aliases/type-alias.PaymentReason.md) | -| `telephones` | [`Telephone`](../classes/class.Telephone.md)[] | -| `threeDigitsSecureCriteria`? | [`PaymentThreeDSCriteria`](../classes/class.PaymentThreeDSCriteria.md) | -| `verifiedAmount`? | [`Amount`](../classes/class.Amount.md) | -| `virtualCreditCardFlag`? | `boolean` | -| `walletType`? | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.CruiseProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.CruiseProperties.md deleted file mode 100644 index cac82f7b..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.CruiseProperties.md +++ /dev/null @@ -1,22 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > CruiseProperties - -# Interface: CruiseProperties - -## Extends - -- [`TravelProductProperties`](interface.TravelProductProperties.md) - -## Properties - -| Property | Type | -| :--------------------- | :--------------------------------------------------------------------------------------------------- | -| `arrivalTime` | `Date` | -| `departureTime` | `Date` | -| `disembarkationPort` | `string` | -| `embarkationPort` | `string` | -| `inventorySource` | [`TravelProductInventorySourceEnum`](../type-aliases/type-alias.TravelProductInventorySourceEnum.md) | -| `inventoryType` | `string` | -| `payLater`? | `boolean` | -| `price` | [`Amount`](../classes/class.Amount.md) | -| `shipName` | `string` | -| `travelersReferences`? | `string`[] | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.CurrentUserSessionProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.CurrentUserSessionProperties.md deleted file mode 100644 index 329a7fe7..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.CurrentUserSessionProperties.md +++ /dev/null @@ -1,11 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > CurrentUserSessionProperties - -# Interface: CurrentUserSessionProperties - -## Properties - -| Property | Type | -| :----------------- | :------------------------------------------------------- | -| `challengeDetail`? | [`ChallengeDetail`](../classes/class.ChallengeDetail.md) | -| `sessionId`? | `string` | -| `startDateTime`? | `Date` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.CustomerAccountAddressProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.CustomerAccountAddressProperties.md deleted file mode 100644 index 1d53b882..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.CustomerAccountAddressProperties.md +++ /dev/null @@ -1,15 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > CustomerAccountAddressProperties - -# Interface: CustomerAccountAddressProperties - -## Properties - -| Property | Type | -| :-------------- | :------------------------------------------------------------------------------------------------------------- | -| `addressLine1` | `string` | -| `addressLine2`? | `string` | -| `addressType`? | [`CustomerAccountAddressAddressTypeEnum`](../type-aliases/type-alias.CustomerAccountAddressAddressTypeEnum.md) | -| `city` | `string` | -| `countryCode` | `string` | -| `state` | `string` | -| `zipCode` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.CustomerAccountProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.CustomerAccountProperties.md deleted file mode 100644 index 1ed40eb9..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.CustomerAccountProperties.md +++ /dev/null @@ -1,15 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > CustomerAccountProperties - -# Interface: CustomerAccountProperties - -## Properties - -| Property | Type | -| :---------------- | :----------------------------------------------------------------------------------------------- | -| `accountType` | [`CustomerAccountAccountTypeEnum`](../type-aliases/type-alias.CustomerAccountAccountTypeEnum.md) | -| `address`? | [`CustomerAccountAddress`](../classes/class.CustomerAccountAddress.md) | -| `emailAddress` | `string` | -| `name` | [`Name`](../classes/class.Name.md) | -| `registeredTime`? | `Date` | -| `telephones`? | [`Telephone`](../classes/class.Telephone.md)[] | -| `userId`? | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.DeviceDetailsProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.DeviceDetailsProperties.md deleted file mode 100644 index bd8085d6..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.DeviceDetailsProperties.md +++ /dev/null @@ -1,11 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > DeviceDetailsProperties - -# Interface: DeviceDetailsProperties - -## Properties - -| Property | Type | -| :----------- | :------- | -| `deviceBox`? | `string` | -| `ipAddress` | `string` | -| `source`? | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.DirectDebitProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.DirectDebitProperties.md deleted file mode 100644 index 925c7671..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.DirectDebitProperties.md +++ /dev/null @@ -1,24 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > DirectDebitProperties - -# Interface: DirectDebitProperties - -## Extends - -- [`PaymentProperties`](interface.PaymentProperties.md) - -## Properties - -| Property | Type | -| :--------------------------- | :--------------------------------------------------------------------- | -| `accountNumber` | `string` | -| `authorizedAmount`? | [`Amount`](../classes/class.Amount.md) | -| `billingAddress` | [`PaymentBillingAddress`](../classes/class.PaymentBillingAddress.md) | -| `billingEmailAddress` | `string` | -| `billingName` | [`Name`](../classes/class.Name.md) | -| `brand` | [`PaymentBrandEnum`](../type-aliases/type-alias.PaymentBrandEnum.md) | -| `operations`? | [`Operations`](../classes/class.Operations.md) | -| `reason`? | [`PaymentReason`](../type-aliases/type-alias.PaymentReason.md) | -| `routingNumber` | `string` | -| `telephones` | [`Telephone`](../classes/class.Telephone.md)[] | -| `threeDigitsSecureCriteria`? | [`PaymentThreeDSCriteria`](../classes/class.PaymentThreeDSCriteria.md) | -| `verifiedAmount`? | [`Amount`](../classes/class.Amount.md) | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.ForbiddenErrorProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.ForbiddenErrorProperties.md deleted file mode 100644 index eb63921b..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.ForbiddenErrorProperties.md +++ /dev/null @@ -1,10 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > ForbiddenErrorProperties - -# Interface: ForbiddenErrorProperties - -## Properties - -| Property | Type | -| :-------- | :------------------------------------------------------------------------------- | -| `code` | [`ForbiddenErrorCodeEnum`](../type-aliases/type-alias.ForbiddenErrorCodeEnum.md) | -| `message` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.GatewayTimeoutErrorProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.GatewayTimeoutErrorProperties.md deleted file mode 100644 index 26e655b0..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.GatewayTimeoutErrorProperties.md +++ /dev/null @@ -1,10 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > GatewayTimeoutErrorProperties - -# Interface: GatewayTimeoutErrorProperties - -## Properties - -| Property | Type | -| :-------- | :----------------------------------------------------------------------------------------- | -| `code` | [`GatewayTimeoutErrorCodeEnum`](../type-aliases/type-alias.GatewayTimeoutErrorCodeEnum.md) | -| `message` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.GiftCardProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.GiftCardProperties.md deleted file mode 100644 index 7716c3cf..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.GiftCardProperties.md +++ /dev/null @@ -1,24 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > GiftCardProperties - -# Interface: GiftCardProperties - -## Extends - -- [`PaymentProperties`](interface.PaymentProperties.md) - -## Properties - -| Property | Type | -| :--------------------------- | :--------------------------------------------------------------------- | -| `authorizedAmount`? | [`Amount`](../classes/class.Amount.md) | -| `billingAddress` | [`PaymentBillingAddress`](../classes/class.PaymentBillingAddress.md) | -| `billingEmailAddress` | `string` | -| `billingName` | [`Name`](../classes/class.Name.md) | -| `brand` | [`PaymentBrandEnum`](../type-aliases/type-alias.PaymentBrandEnum.md) | -| `cardHolderName` | `string` | -| `cardNumber` | `string` | -| `operations`? | [`Operations`](../classes/class.Operations.md) | -| `pin` | `string` | -| `reason`? | [`PaymentReason`](../type-aliases/type-alias.PaymentReason.md) | -| `threeDigitsSecureCriteria`? | [`PaymentThreeDSCriteria`](../classes/class.PaymentThreeDSCriteria.md) | -| `verifiedAmount`? | [`Amount`](../classes/class.Amount.md) | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.HotelAddressProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.HotelAddressProperties.md deleted file mode 100644 index 8f7ade15..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.HotelAddressProperties.md +++ /dev/null @@ -1,15 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > HotelAddressProperties - -# Interface: HotelAddressProperties - -## Properties - -| Property | Type | -| :-------------- | :----------------------------------------------------------------------------------------- | -| `addressLine1` | `string` | -| `addressLine2`? | `string` | -| `addressType`? | [`HotelAddressAddressTypeEnum`](../type-aliases/type-alias.HotelAddressAddressTypeEnum.md) | -| `city` | `string` | -| `countryCode` | `string` | -| `state` | `string` | -| `zipCode` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.HotelAllOfAddressProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.HotelAllOfAddressProperties.md deleted file mode 100644 index cd214546..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.HotelAllOfAddressProperties.md +++ /dev/null @@ -1,15 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > HotelAllOfAddressProperties - -# Interface: HotelAllOfAddressProperties - -## Properties - -| Property | Type | -| :-------------- | :--------------------------------------------------------------------------------------------------- | -| `addressLine1` | `string` | -| `addressLine2`? | `string` | -| `addressType`? | [`HotelAllOfAddressAddressTypeEnum`](../type-aliases/type-alias.HotelAllOfAddressAddressTypeEnum.md) | -| `city` | `string` | -| `countryCode` | `string` | -| `state` | `string` | -| `zipCode` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.HotelProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.HotelProperties.md deleted file mode 100644 index 3af717c4..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.HotelProperties.md +++ /dev/null @@ -1,24 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > HotelProperties - -# Interface: HotelProperties - -## Extends - -- [`TravelProductProperties`](interface.TravelProductProperties.md) - -## Properties - -| Property | Type | -| :--------------------- | :--------------------------------------------------------------------------------------------------- | -| `address` | [`HotelAllOfAddress`](../classes/class.HotelAllOfAddress.md) | -| `checkinTime` | `Date` | -| `checkoutTime` | `Date` | -| `hotelId` | `string` | -| `hotelName` | `string` | -| `inventorySource` | [`TravelProductInventorySourceEnum`](../type-aliases/type-alias.TravelProductInventorySourceEnum.md) | -| `inventoryType` | `string` | -| `payLater`? | `boolean` | -| `price` | [`Amount`](../classes/class.Amount.md) | -| `priceWithheld`? | `boolean` | -| `roomCount`? | `number` | -| `travelersReferences`? | `string`[] | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.InsultFeedbackProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.InsultFeedbackProperties.md deleted file mode 100644 index 00e0027e..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.InsultFeedbackProperties.md +++ /dev/null @@ -1,14 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > InsultFeedbackProperties - -# Interface: InsultFeedbackProperties - -## Extends - -- [`OrderPurchaseUpdateRequestProperties`](interface.OrderPurchaseUpdateRequestProperties.md) - -## Properties - -| Property | Type | -| :-------------- | :------------------------------------------------- | -| `insultDetail`? | [`InsultDetail`](../classes/class.InsultDetail.md) | -| `riskId` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.InsuranceProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.InsuranceProperties.md deleted file mode 100644 index 6fb7d6d3..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.InsuranceProperties.md +++ /dev/null @@ -1,17 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > InsuranceProperties - -# Interface: InsuranceProperties - -## Extends - -- [`TravelProductProperties`](interface.TravelProductProperties.md) - -## Properties - -| Property | Type | -| :--------------------- | :--------------------------------------------------------------------------------------------------- | -| `inventorySource` | [`TravelProductInventorySourceEnum`](../type-aliases/type-alias.TravelProductInventorySourceEnum.md) | -| `inventoryType` | `string` | -| `payLater`? | `boolean` | -| `price` | [`Amount`](../classes/class.Amount.md) | -| `travelersReferences`? | `string`[] | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.InternalServerErrorProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.InternalServerErrorProperties.md deleted file mode 100644 index 0dddf2bf..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.InternalServerErrorProperties.md +++ /dev/null @@ -1,10 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > InternalServerErrorProperties - -# Interface: InternalServerErrorProperties - -## Properties - -| Property | Type | -| :-------- | :----------------------------------------------------------------------------------------- | -| `code` | [`InternalServerErrorCodeEnum`](../type-aliases/type-alias.InternalServerErrorCodeEnum.md) | -| `message` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.InternetBankPaymentProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.InternetBankPaymentProperties.md deleted file mode 100644 index 7de9c7d7..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.InternetBankPaymentProperties.md +++ /dev/null @@ -1,24 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > InternetBankPaymentProperties - -# Interface: InternetBankPaymentProperties - -## Extends - -- [`PaymentProperties`](interface.PaymentProperties.md) - -## Properties - -| Property | Type | -| :--------------------------- | :--------------------------------------------------------------------- | -| `authorizedAmount`? | [`Amount`](../classes/class.Amount.md) | -| `bankBranchCode` | `string` | -| `bankId` | `string` | -| `billingAddress` | [`PaymentBillingAddress`](../classes/class.PaymentBillingAddress.md) | -| `billingEmailAddress` | `string` | -| `billingName` | [`Name`](../classes/class.Name.md) | -| `brand` | [`PaymentBrandEnum`](../type-aliases/type-alias.PaymentBrandEnum.md) | -| `operations`? | [`Operations`](../classes/class.Operations.md) | -| `reason`? | [`PaymentReason`](../type-aliases/type-alias.PaymentReason.md) | -| `telephones` | [`Telephone`](../classes/class.Telephone.md)[] | -| `threeDigitsSecureCriteria`? | [`PaymentThreeDSCriteria`](../classes/class.PaymentThreeDSCriteria.md) | -| `verifiedAmount`? | [`Amount`](../classes/class.Amount.md) | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.IssuedRefundUpdateDetailsProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.IssuedRefundUpdateDetailsProperties.md deleted file mode 100644 index e5d86fa4..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.IssuedRefundUpdateDetailsProperties.md +++ /dev/null @@ -1,10 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > IssuedRefundUpdateDetailsProperties - -# Interface: IssuedRefundUpdateDetailsProperties - -## Properties - -| Property | Type | -| :--------------------- | :------------------------------------- | -| `refundIssuedAmount` | [`Amount`](../classes/class.Amount.md) | -| `refundIssuedDateTime` | `Date` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.IssuedRefundUpdateProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.IssuedRefundUpdateProperties.md deleted file mode 100644 index 3f2a9fb4..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.IssuedRefundUpdateProperties.md +++ /dev/null @@ -1,14 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > IssuedRefundUpdateProperties - -# Interface: IssuedRefundUpdateProperties - -## Extends - -- [`RefundUpdateProperties`](interface.RefundUpdateProperties.md) - -## Properties - -| Property | Type | -| :--------------- | :--------------------------------------------------------------------------- | -| `refundDetails`? | [`IssuedRefundUpdateDetails`](../classes/class.IssuedRefundUpdateDetails.md) | -| `riskId` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.LoginTransactionDetailsProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.LoginTransactionDetailsProperties.md deleted file mode 100644 index 22cb189c..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.LoginTransactionDetailsProperties.md +++ /dev/null @@ -1,19 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > LoginTransactionDetailsProperties - -# Interface: LoginTransactionDetailsProperties - -## Extends - -- [`AccountTakeoverTransactionDetailsProperties`](interface.AccountTakeoverTransactionDetailsProperties.md) - -## Properties - -| Property | Type | -| :----------------------- | :----------------------------------------------------------------------------------------------------------------------------------- | -| `authenticationSubType`? | [`LoginTransactionDetailsAuthenticationSubTypeEnum`](../type-aliases/type-alias.LoginTransactionDetailsAuthenticationSubTypeEnum.md) | -| `authenticationType` | [`LoginTransactionDetailsAuthenticationTypeEnum`](../type-aliases/type-alias.LoginTransactionDetailsAuthenticationTypeEnum.md) | -| `currentUserSession`? | [`CurrentUserSession`](../classes/class.CurrentUserSession.md) | -| `failedLoginReason`? | [`LoginTransactionDetailsFailedLoginReasonEnum`](../type-aliases/type-alias.LoginTransactionDetailsFailedLoginReasonEnum.md) | -| `successfulLoginFlag` | `boolean` | -| `transactionDateTime` | `Date` | -| `transactionId` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.ModelErrorProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.ModelErrorProperties.md deleted file mode 100644 index 6b75a97a..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.ModelErrorProperties.md +++ /dev/null @@ -1,10 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > ModelErrorProperties - -# Interface: ModelErrorProperties - -## Properties - -| Property | Type | -| :-------- | :----------------------------------------------------------------------- | -| `code` | [`ModelErrorCodeEnum`](../type-aliases/type-alias.ModelErrorCodeEnum.md) | -| `message` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.MultiFactorAuthenticationAttemptProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.MultiFactorAuthenticationAttemptProperties.md deleted file mode 100644 index f625b915..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.MultiFactorAuthenticationAttemptProperties.md +++ /dev/null @@ -1,17 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > MultiFactorAuthenticationAttemptProperties - -# Interface: MultiFactorAuthenticationAttemptProperties - -## Properties - -| Property | Type | -| :--------------------- | :--------------------------------------------------------------------------------------------------------------------------------------- | -| `attemptCount` | `number` | -| `deliveryMethod` | [`MultiFactorAuthenticationAttemptDeliveryMethodEnum`](../type-aliases/type-alias.MultiFactorAuthenticationAttemptDeliveryMethodEnum.md) | -| `emailAddress`? | `string` | -| `providerName` | `string` | -| `referenceId` | `string` | -| `status` | [`MultiFactorAuthenticationAttemptStatusEnum`](../type-aliases/type-alias.MultiFactorAuthenticationAttemptStatusEnum.md) | -| `telephone`? | [`Telephone`](../classes/class.Telephone.md) | -| `updateEndDateTime`? | `Date` | -| `updateStartDateTime`? | `Date` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.MultiFactorAuthenticationUpdateProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.MultiFactorAuthenticationUpdateProperties.md deleted file mode 100644 index 29474c4f..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.MultiFactorAuthenticationUpdateProperties.md +++ /dev/null @@ -1,14 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > MultiFactorAuthenticationUpdateProperties - -# Interface: MultiFactorAuthenticationUpdateProperties - -## Extends - -- [`AccountUpdateRequestProperties`](interface.AccountUpdateRequestProperties.md) - -## Properties - -| Property | Type | -| :---------------------------------- | :------------------------------------------------------------------------------------------- | -| `multiFactorAuthenticationAttempts` | [`MultiFactorAuthenticationAttempt`](../classes/class.MultiFactorAuthenticationAttempt.md)[] | -| `riskId` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.NameProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.NameProperties.md deleted file mode 100644 index 0de7d262..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.NameProperties.md +++ /dev/null @@ -1,13 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > NameProperties - -# Interface: NameProperties - -## Properties - -| Property | Type | -| :------------ | :------- | -| `firstName` | `string` | -| `lastName` | `string` | -| `middleName`? | `string` | -| `suffix`? | `string` | -| `title`? | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.NotFoundErrorProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.NotFoundErrorProperties.md deleted file mode 100644 index aa277500..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.NotFoundErrorProperties.md +++ /dev/null @@ -1,10 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > NotFoundErrorProperties - -# Interface: NotFoundErrorProperties - -## Properties - -| Property | Type | -| :-------- | :----------------------------------------------------------------------------- | -| `code` | [`NotFoundErrorCodeEnum`](../type-aliases/type-alias.NotFoundErrorCodeEnum.md) | -| `message` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.OperationsProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.OperationsProperties.md deleted file mode 100644 index c9fe01ec..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.OperationsProperties.md +++ /dev/null @@ -1,13 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > OperationsProperties - -# Interface: OperationsProperties - -## Properties - -| Property | Type | -| :------------------- | :----------------------------------------------------------- | -| `authorize`? | [`Authorize`](../classes/class.Authorize.md) | -| `authorizeReversal`? | [`AuthorizeReversal`](../classes/class.AuthorizeReversal.md) | -| `capture`? | [`Capture`](../classes/class.Capture.md) | -| `refunds`? | [`Refund`](../classes/class.Refund.md)[] | -| `verify`? | [`Verify`](../classes/class.Verify.md) | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.OrderPurchaseScreenRequestProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.OrderPurchaseScreenRequestProperties.md deleted file mode 100644 index e0d42507..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.OrderPurchaseScreenRequestProperties.md +++ /dev/null @@ -1,9 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > OrderPurchaseScreenRequestProperties - -# Interface: OrderPurchaseScreenRequestProperties - -## Properties - -| Property | Type | -| :------------ | :------------------------------------------------------------------------- | -| `transaction` | [`OrderPurchaseTransaction`](../classes/class.OrderPurchaseTransaction.md) | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.OrderPurchaseScreenResponseProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.OrderPurchaseScreenResponseProperties.md deleted file mode 100644 index befac0bd..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.OrderPurchaseScreenResponseProperties.md +++ /dev/null @@ -1,10 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > OrderPurchaseScreenResponseProperties - -# Interface: OrderPurchaseScreenResponseProperties - -## Properties - -| Property | Type | -| :---------- | :------------------------------------------------------------- | -| `decision`? | [`FraudDecision`](../type-aliases/type-alias.FraudDecision.md) | -| `riskId`? | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.OrderPurchaseTransactionProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.OrderPurchaseTransactionProperties.md deleted file mode 100644 index f232ef70..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.OrderPurchaseTransactionProperties.md +++ /dev/null @@ -1,12 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > OrderPurchaseTransactionProperties - -# Interface: OrderPurchaseTransactionProperties - -## Properties - -| Property | Type | -| :------------------- | :------------------------------------------------------------- | -| `customerAccount` | [`CustomerAccount`](../classes/class.CustomerAccount.md) | -| `deviceDetails` | [`DeviceDetails`](../classes/class.DeviceDetails.md) | -| `siteInfo` | [`SiteInfo`](../classes/class.SiteInfo.md) | -| `transactionDetails` | [`TransactionDetails`](../classes/class.TransactionDetails.md) | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.OrderPurchaseUpdateNotFoundErrorProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.OrderPurchaseUpdateNotFoundErrorProperties.md deleted file mode 100644 index 10cc894f..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.OrderPurchaseUpdateNotFoundErrorProperties.md +++ /dev/null @@ -1,10 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > OrderPurchaseUpdateNotFoundErrorProperties - -# Interface: OrderPurchaseUpdateNotFoundErrorProperties - -## Properties - -| Property | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------- | -| `code` | [`OrderPurchaseUpdateNotFoundErrorCodeEnum`](../type-aliases/type-alias.OrderPurchaseUpdateNotFoundErrorCodeEnum.md) | -| `message` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.OrderPurchaseUpdateRequestProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.OrderPurchaseUpdateRequestProperties.md deleted file mode 100644 index ff9a6e07..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.OrderPurchaseUpdateRequestProperties.md +++ /dev/null @@ -1,17 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > OrderPurchaseUpdateRequestProperties - -# Interface: OrderPurchaseUpdateRequestProperties - -## Extended By - -- [`ChargebackFeedbackProperties`](interface.ChargebackFeedbackProperties.md) -- [`InsultFeedbackProperties`](interface.InsultFeedbackProperties.md) -- [`OrderUpdateProperties`](interface.OrderUpdateProperties.md) -- [`PaymentUpdateProperties`](interface.PaymentUpdateProperties.md) -- [`RefundUpdateProperties`](interface.RefundUpdateProperties.md) - -## Properties - -| Property | Type | -| :------- | :------- | -| `riskId` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.OrderUpdateProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.OrderUpdateProperties.md deleted file mode 100644 index 9c3fa441..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.OrderUpdateProperties.md +++ /dev/null @@ -1,16 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > OrderUpdateProperties - -# Interface: OrderUpdateProperties - -## Extends - -- [`OrderPurchaseUpdateRequestProperties`](interface.OrderPurchaseUpdateRequestProperties.md) - -## Properties - -| Property | Type | -| :------------------------- | :------------------------------------------------------------- | -| `acquirerReferenceNumber`? | `string` | -| `cancellationReason`? | [`CancellationReason`](../classes/class.CancellationReason.md) | -| `orderStatus` | [`Status`](../type-aliases/type-alias.Status.md) | -| `riskId` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.PayPalProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.PayPalProperties.md deleted file mode 100644 index 8b991104..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.PayPalProperties.md +++ /dev/null @@ -1,24 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > PayPalProperties - -# Interface: PayPalProperties - -## Extends - -- [`PaymentProperties`](interface.PaymentProperties.md) - -## Properties - -| Property | Type | -| :--------------------------- | :--------------------------------------------------------------------- | -| `authorizedAmount`? | [`Amount`](../classes/class.Amount.md) | -| `billingAddress` | [`PaymentBillingAddress`](../classes/class.PaymentBillingAddress.md) | -| `billingEmailAddress` | `string` | -| `billingName` | [`Name`](../classes/class.Name.md) | -| `brand` | [`PaymentBrandEnum`](../type-aliases/type-alias.PaymentBrandEnum.md) | -| `merchantOrderCode`? | `string` | -| `operations`? | [`Operations`](../classes/class.Operations.md) | -| `payerId` | `string` | -| `reason`? | [`PaymentReason`](../type-aliases/type-alias.PaymentReason.md) | -| `threeDigitsSecureCriteria`? | [`PaymentThreeDSCriteria`](../classes/class.PaymentThreeDSCriteria.md) | -| `transactionId` | `string` | -| `verifiedAmount`? | [`Amount`](../classes/class.Amount.md) | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.PaymentBillingAddressProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.PaymentBillingAddressProperties.md deleted file mode 100644 index 9c92d367..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.PaymentBillingAddressProperties.md +++ /dev/null @@ -1,15 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > PaymentBillingAddressProperties - -# Interface: PaymentBillingAddressProperties - -## Properties - -| Property | Type | -| :-------------- | :----------------------------------------------------------------------------------------------------------- | -| `addressLine1` | `string` | -| `addressLine2`? | `string` | -| `addressType`? | [`PaymentBillingAddressAddressTypeEnum`](../type-aliases/type-alias.PaymentBillingAddressAddressTypeEnum.md) | -| `city` | `string` | -| `countryCode` | `string` | -| `state`? | `string` | -| `zipCode` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.PaymentOperationProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.PaymentOperationProperties.md deleted file mode 100644 index d6825e9b..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.PaymentOperationProperties.md +++ /dev/null @@ -1,11 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > PaymentOperationProperties - -# Interface: PaymentOperationProperties - -## Properties - -| Property | Type | -| :--------- | :----------------------------------------------------- | -| `amount`? | [`Amount`](../classes/class.Amount.md) | -| `id`? | `string` | -| `outcome`? | [`PaymentOutcome`](../classes/class.PaymentOutcome.md) | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.PaymentOutcomeProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.PaymentOutcomeProperties.md deleted file mode 100644 index 952095a0..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.PaymentOutcomeProperties.md +++ /dev/null @@ -1,11 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > PaymentOutcomeProperties - -# Interface: PaymentOutcomeProperties - -## Properties - -| Property | Type | -| :------------- | :------------------------------------------------------------- | -| `code`? | `string` | -| `description`? | `string` | -| `status`? | [`PaymentStatus`](../type-aliases/type-alias.PaymentStatus.md) | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.PaymentProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.PaymentProperties.md deleted file mode 100644 index 008dd422..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.PaymentProperties.md +++ /dev/null @@ -1,26 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > PaymentProperties - -# Interface: PaymentProperties - -## Extended By - -- [`CreditCardProperties`](interface.CreditCardProperties.md) -- [`DirectDebitProperties`](interface.DirectDebitProperties.md) -- [`GiftCardProperties`](interface.GiftCardProperties.md) -- [`InternetBankPaymentProperties`](interface.InternetBankPaymentProperties.md) -- [`PayPalProperties`](interface.PayPalProperties.md) -- [`PointsProperties`](interface.PointsProperties.md) - -## Properties - -| Property | Type | -| :--------------------------- | :--------------------------------------------------------------------- | -| `authorizedAmount`? | [`Amount`](../classes/class.Amount.md) | -| `billingAddress` | [`PaymentBillingAddress`](../classes/class.PaymentBillingAddress.md) | -| `billingEmailAddress` | `string` | -| `billingName` | [`Name`](../classes/class.Name.md) | -| `brand` | [`PaymentBrandEnum`](../type-aliases/type-alias.PaymentBrandEnum.md) | -| `operations`? | [`Operations`](../classes/class.Operations.md) | -| `reason`? | [`PaymentReason`](../type-aliases/type-alias.PaymentReason.md) | -| `threeDigitsSecureCriteria`? | [`PaymentThreeDSCriteria`](../classes/class.PaymentThreeDSCriteria.md) | -| `verifiedAmount`? | [`Amount`](../classes/class.Amount.md) | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.PaymentThreeDSCriteriaProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.PaymentThreeDSCriteriaProperties.md deleted file mode 100644 index bf44a86e..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.PaymentThreeDSCriteriaProperties.md +++ /dev/null @@ -1,10 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > PaymentThreeDSCriteriaProperties - -# Interface: PaymentThreeDSCriteriaProperties - -## Properties - -| Property | Type | -| :------------------ | :-------- | -| `probableFlag`? | `boolean` | -| `transactionModel`? | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.PaymentUpdateProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.PaymentUpdateProperties.md deleted file mode 100644 index b43e31b4..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.PaymentUpdateProperties.md +++ /dev/null @@ -1,14 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > PaymentUpdateProperties - -# Interface: PaymentUpdateProperties - -## Extends - -- [`OrderPurchaseUpdateRequestProperties`](interface.OrderPurchaseUpdateRequestProperties.md) - -## Properties - -| Property | Type | -| :------------------ | :------- | -| `merchantOrderCode` | `string` | -| `riskId` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.PointsProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.PointsProperties.md deleted file mode 100644 index 4722c00e..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.PointsProperties.md +++ /dev/null @@ -1,22 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > PointsProperties - -# Interface: PointsProperties - -## Extends - -- [`PaymentProperties`](interface.PaymentProperties.md) - -## Properties - -| Property | Type | -| :--------------------------- | :--------------------------------------------------------------------- | -| `accountId` | `string` | -| `authorizedAmount`? | [`Amount`](../classes/class.Amount.md) | -| `billingAddress` | [`PaymentBillingAddress`](../classes/class.PaymentBillingAddress.md) | -| `billingEmailAddress` | `string` | -| `billingName` | [`Name`](../classes/class.Name.md) | -| `brand` | [`PaymentBrandEnum`](../type-aliases/type-alias.PaymentBrandEnum.md) | -| `operations`? | [`Operations`](../classes/class.Operations.md) | -| `reason`? | [`PaymentReason`](../type-aliases/type-alias.PaymentReason.md) | -| `threeDigitsSecureCriteria`? | [`PaymentThreeDSCriteria`](../classes/class.PaymentThreeDSCriteria.md) | -| `verifiedAmount`? | [`Amount`](../classes/class.Amount.md) | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.RailProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.RailProperties.md deleted file mode 100644 index c045269e..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.RailProperties.md +++ /dev/null @@ -1,19 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > RailProperties - -# Interface: RailProperties - -## Extends - -- [`TravelProductProperties`](interface.TravelProductProperties.md) - -## Properties - -| Property | Type | -| :--------------------- | :--------------------------------------------------------------------------------------------------- | -| `inventorySource` | [`TravelProductInventorySourceEnum`](../type-aliases/type-alias.TravelProductInventorySourceEnum.md) | -| `inventoryType` | `string` | -| `payLater`? | `boolean` | -| `price` | [`Amount`](../classes/class.Amount.md) | -| `railSegments` | [`RailSegments`](../classes/class.RailSegments.md)[] | -| `routeType` | [`RailRouteTypeEnum`](../type-aliases/type-alias.RailRouteTypeEnum.md) | -| `travelersReferences`? | `string`[] | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.RailSegmentsProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.RailSegmentsProperties.md deleted file mode 100644 index 3ffc134a..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.RailSegmentsProperties.md +++ /dev/null @@ -1,14 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > RailSegmentsProperties - -# Interface: RailSegmentsProperties - -## Properties - -| Property | Type | -| :--------------------- | :----------------------------------------------------------------------------------------------------------- | -| `arrivalStation` | [`RailwayStationDetails`](../classes/class.RailwayStationDetails.md) | -| `arrivalTime` | `Date` | -| `departureStation` | [`RailwayStationDetails`](../classes/class.RailwayStationDetails.md) | -| `departureTime` | `Date` | -| `operatingCompany`? | [`RailSegmentsOperatingCompany`](../classes/class.RailSegmentsOperatingCompany.md) | -| `transportationMethod` | [`RailSegmentsTransportationMethodEnum`](../type-aliases/type-alias.RailSegmentsTransportationMethodEnum.md) | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.RailwayStationDetailsProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.RailwayStationDetailsProperties.md deleted file mode 100644 index 42df871d..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.RailwayStationDetailsProperties.md +++ /dev/null @@ -1,13 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > RailwayStationDetailsProperties - -# Interface: RailwayStationDetailsProperties - -## Properties - -| Property | Type | -| :------------ | :--------------------------------------------------------------------------------------------- | -| `address` | [`CustomerAccountAddress`](../classes/class.CustomerAccountAddress.md) | -| `name` | `string` | -| `stationCode` | `string` | -| `timezone`? | `string` | -| `type`? | [`RailwayStationDetailsTypeEnum`](../type-aliases/type-alias.RailwayStationDetailsTypeEnum.md) | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.RefundProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.RefundProperties.md deleted file mode 100644 index 84049755..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.RefundProperties.md +++ /dev/null @@ -1,11 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > RefundProperties - -# Interface: RefundProperties - -## Properties - -| Property | Type | -| :--------- | :----------------------------------------------------- | -| `amount`? | [`Amount`](../classes/class.Amount.md) | -| `id`? | `string` | -| `outcome`? | [`PaymentOutcome`](../classes/class.PaymentOutcome.md) | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.RefundUpdateProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.RefundUpdateProperties.md deleted file mode 100644 index 9e5ffda0..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.RefundUpdateProperties.md +++ /dev/null @@ -1,13 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > RefundUpdateProperties - -# Interface: RefundUpdateProperties - -## Extends - -- [`OrderPurchaseUpdateRequestProperties`](interface.OrderPurchaseUpdateRequestProperties.md) - -## Properties - -| Property | Type | -| :------- | :------- | -| `riskId` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.RemediationUpdateActionProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.RemediationUpdateActionProperties.md deleted file mode 100644 index 1ac0bebb..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.RemediationUpdateActionProperties.md +++ /dev/null @@ -1,11 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > RemediationUpdateActionProperties - -# Interface: RemediationUpdateActionProperties - -## Properties - -| Property | Type | -| :------------------- | :------------------------------------------------------------------------------------------------------------- | -| `actionName` | [`RemediationUpdateActionActionNameEnum`](../type-aliases/type-alias.RemediationUpdateActionActionNameEnum.md) | -| `status` | [`RemediationUpdateActionStatusEnum`](../type-aliases/type-alias.RemediationUpdateActionStatusEnum.md) | -| `updateEndDateTime`? | `Date` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.RemediationUpdateProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.RemediationUpdateProperties.md deleted file mode 100644 index 0ee9b33c..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.RemediationUpdateProperties.md +++ /dev/null @@ -1,14 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > RemediationUpdateProperties - -# Interface: RemediationUpdateProperties - -## Extends - -- [`AccountUpdateRequestProperties`](interface.AccountUpdateRequestProperties.md) - -## Properties - -| Property | Type | -| :------------------------- | :------------------------------------------------------------------------- | -| `remediationUpdateActions` | [`RemediationUpdateAction`](../classes/class.RemediationUpdateAction.md)[] | -| `riskId` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.RetryableOrderPurchaseScreenFailureProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.RetryableOrderPurchaseScreenFailureProperties.md deleted file mode 100644 index a097401c..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.RetryableOrderPurchaseScreenFailureProperties.md +++ /dev/null @@ -1,10 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > RetryableOrderPurchaseScreenFailureProperties - -# Interface: RetryableOrderPurchaseScreenFailureProperties - -## Properties - -| Property | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------- | -| `code` | [`RetryableOrderPurchaseScreenFailureCodeEnum`](../type-aliases/type-alias.RetryableOrderPurchaseScreenFailureCodeEnum.md) | -| `message` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.RetryableOrderPurchaseUpdateFailureProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.RetryableOrderPurchaseUpdateFailureProperties.md deleted file mode 100644 index f19e6ecb..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.RetryableOrderPurchaseUpdateFailureProperties.md +++ /dev/null @@ -1,10 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > RetryableOrderPurchaseUpdateFailureProperties - -# Interface: RetryableOrderPurchaseUpdateFailureProperties - -## Properties - -| Property | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------- | -| `code` | [`RetryableOrderPurchaseUpdateFailureCodeEnum`](../type-aliases/type-alias.RetryableOrderPurchaseUpdateFailureCodeEnum.md) | -| `message` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.ServiceUnavailableErrorProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.ServiceUnavailableErrorProperties.md deleted file mode 100644 index 2847b951..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.ServiceUnavailableErrorProperties.md +++ /dev/null @@ -1,10 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > ServiceUnavailableErrorProperties - -# Interface: ServiceUnavailableErrorProperties - -## Properties - -| Property | Type | -| :-------- | :------------------------------------------------------------------------------------------------- | -| `code` | [`ServiceUnavailableErrorCodeEnum`](../type-aliases/type-alias.ServiceUnavailableErrorCodeEnum.md) | -| `message` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.SettledRefundUpdateDetailsProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.SettledRefundUpdateDetailsProperties.md deleted file mode 100644 index 3a538111..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.SettledRefundUpdateDetailsProperties.md +++ /dev/null @@ -1,13 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > SettledRefundUpdateDetailsProperties - -# Interface: SettledRefundUpdateDetailsProperties - -## Properties - -| Property | Type | -| :------------------------- | :------------------------------------- | -| `acquirerReferenceNumber` | `string` | -| `refundDepositDateTime` | `Date` | -| `refundSettledAmount` | [`Amount`](../classes/class.Amount.md) | -| `refundSettlementDateTime` | `Date` | -| `settlementId` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.SettledRefundUpdateProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.SettledRefundUpdateProperties.md deleted file mode 100644 index 01c28c43..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.SettledRefundUpdateProperties.md +++ /dev/null @@ -1,14 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > SettledRefundUpdateProperties - -# Interface: SettledRefundUpdateProperties - -## Extends - -- [`RefundUpdateProperties`](interface.RefundUpdateProperties.md) - -## Properties - -| Property | Type | -| :--------------- | :----------------------------------------------------------------------------- | -| `refundDetails`? | [`SettledRefundUpdateDetails`](../classes/class.SettledRefundUpdateDetails.md) | -| `riskId` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.SiteInfoProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.SiteInfoProperties.md deleted file mode 100644 index bec85213..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.SiteInfoProperties.md +++ /dev/null @@ -1,10 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > SiteInfoProperties - -# Interface: SiteInfoProperties - -## Properties - -| Property | Type | -| :-------------- | :-------- | -| `agentAssisted` | `boolean` | -| `countryCode` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.TelephoneProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.TelephoneProperties.md deleted file mode 100644 index e60601ad..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.TelephoneProperties.md +++ /dev/null @@ -1,17 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > TelephoneProperties - -# Interface: TelephoneProperties - -## Properties - -| Property | Type | -| :---------------------- | :----------------------------------------------------------------------------- | -| `areaCode` | `string` | -| `countryAccessCode` | `string` | -| `extensionNumber`? | `string` | -| `lastVerifiedDateTime`? | `Date` | -| `phoneNumber` | `string` | -| `platformType`? | [`TelephonePlatformType`](../type-aliases/type-alias.TelephonePlatformType.md) | -| `preferenceRank`? | `number` | -| `type`? | [`TelephoneType`](../type-aliases/type-alias.TelephoneType.md) | -| `verifiedFlag`? | `boolean` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.TooManyRequestsErrorProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.TooManyRequestsErrorProperties.md deleted file mode 100644 index 4e3f1427..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.TooManyRequestsErrorProperties.md +++ /dev/null @@ -1,10 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > TooManyRequestsErrorProperties - -# Interface: TooManyRequestsErrorProperties - -## Properties - -| Property | Type | -| :-------- | :------------------------------------------------------------------------------------------- | -| `code` | [`TooManyRequestsErrorCodeEnum`](../type-aliases/type-alias.TooManyRequestsErrorCodeEnum.md) | -| `message` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.TransactionDetailsProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.TransactionDetailsProperties.md deleted file mode 100644 index 8c174bf4..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.TransactionDetailsProperties.md +++ /dev/null @@ -1,14 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > TransactionDetailsProperties - -# Interface: TransactionDetailsProperties - -## Properties - -| Property | Type | -| :------------------- | :------------------------------------------------------------------------------------------------------------------- | -| `currentOrderStatus` | [`TransactionDetailsCurrentOrderStatusEnum`](../type-aliases/type-alias.TransactionDetailsCurrentOrderStatusEnum.md) | -| `orderId` | `string` | -| `orderType` | [`TransactionDetailsOrderTypeEnum`](../type-aliases/type-alias.TransactionDetailsOrderTypeEnum.md) | -| `payments`? | [`Payment`](../classes/class.Payment.md)[] | -| `travelProducts` | [`TravelProduct`](../classes/class.TravelProduct.md)[] | -| `travelers` | [`Traveler`](../classes/class.Traveler.md)[] | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.TravelProductProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.TravelProductProperties.md deleted file mode 100644 index 6ee5c046..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.TravelProductProperties.md +++ /dev/null @@ -1,22 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > TravelProductProperties - -# Interface: TravelProductProperties - -## Extended By - -- [`AirProperties`](interface.AirProperties.md) -- [`CarProperties`](interface.CarProperties.md) -- [`CruiseProperties`](interface.CruiseProperties.md) -- [`HotelProperties`](interface.HotelProperties.md) -- [`InsuranceProperties`](interface.InsuranceProperties.md) -- [`RailProperties`](interface.RailProperties.md) - -## Properties - -| Property | Type | -| :--------------------- | :--------------------------------------------------------------------------------------------------- | -| `inventorySource` | [`TravelProductInventorySourceEnum`](../type-aliases/type-alias.TravelProductInventorySourceEnum.md) | -| `inventoryType` | `string` | -| `payLater`? | `boolean` | -| `price` | [`Amount`](../classes/class.Amount.md) | -| `travelersReferences`? | `string`[] | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.TravelerProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.TravelerProperties.md deleted file mode 100644 index 19f745ee..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.TravelerProperties.md +++ /dev/null @@ -1,16 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > TravelerProperties - -# Interface: TravelerProperties - -## Properties - -| Property | Type | -| :------------------------ | :--------------------------------------------- | -| `age`? | `number` | -| `birthDate`? | `Date` | -| `citizenshipCountryCode`? | `string` | -| `emailAddress`? | `string` | -| `primary` | `boolean` | -| `telephones`? | [`Telephone`](../classes/class.Telephone.md)[] | -| `travelerId`? | `string` | -| `travelerName` | [`Name`](../classes/class.Name.md) | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.UnauthorizedErrorProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.UnauthorizedErrorProperties.md deleted file mode 100644 index 52558f35..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.UnauthorizedErrorProperties.md +++ /dev/null @@ -1,10 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > UnauthorizedErrorProperties - -# Interface: UnauthorizedErrorProperties - -## Properties - -| Property | Type | -| :-------- | :------------------------------------------------------------------------------------- | -| `code` | [`UnauthorizedErrorCodeEnum`](../type-aliases/type-alias.UnauthorizedErrorCodeEnum.md) | -| `message` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.VerifyProperties.md b/release/fraudPreventionV2/docs/models/interfaces/interface.VerifyProperties.md deleted file mode 100644 index b3e65dc2..00000000 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.VerifyProperties.md +++ /dev/null @@ -1,12 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > VerifyProperties - -# Interface: VerifyProperties - -## Properties - -| Property | Type | -| :--------- | :------------------------------------------------------------------- | -| `amount`? | [`Amount`](../classes/class.Amount.md) | -| `id`? | `string` | -| `outcome`? | [`PaymentOutcome`](../classes/class.PaymentOutcome.md) | -| `type`? | [`VerificationType`](../type-aliases/type-alias.VerificationType.md) | diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.HotelAllOfAddressAddressTypeEnum.md b/release/fraudPreventionV2/docs/models/type-aliases/type-alias.HotelAllOfAddressAddressTypeEnum.md deleted file mode 100644 index 0ee72466..00000000 --- a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.HotelAllOfAddressAddressTypeEnum.md +++ /dev/null @@ -1,9 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > HotelAllOfAddressAddressTypeEnum - -# Type alias: HotelAllOfAddressAddressTypeEnum - -> **HotelAllOfAddressAddressTypeEnum**: `"HOME"` \| `"WORK"` - -## Source - -models/HotelAllOfAddress.ts:69 diff --git a/release/fraudPreventionV2/src/client/apis/FraudPreventionV2Client.ts b/release/fraudPreventionV2/src/client/apis/FraudPreventionV2Client.ts index be16c2a6..9e245573 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}/2.2.0 (Node.js ${this.nodeVersion} ${this.operatingSystemName} ${this.operatingSystemVersion})` + private static readonly userAgent: string = `${this.sdkTitle}/3.0.0 (Node.js ${this.nodeVersion} ${this.operatingSystemName} ${this.operatingSystemVersion})` constructor(configurations: ClientConfigurations) { super({ diff --git a/release/fraudPreventionV2/src/docs/client/classes/FraudPreventionV2Client.md b/release/fraudPreventionV2/src/docs/client/classes/FraudPreventionV2Client.md new file mode 100644 index 00000000..c6698594 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/client/classes/FraudPreventionV2Client.md @@ -0,0 +1,273 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [client](../index.md) > FraudPreventionV2Client + +# Class: FraudPreventionV2Client + +## Extends + +- [`Client`](../../models/core/classes/Client.md) + +## Constructors + +### new FraudPreventionV2Client(configurations) + +> **new FraudPreventionV2Client**(`configurations`): [`FraudPreventionV2Client`](FraudPreventionV2Client.md) + +#### Parameters + +▪ **configurations**: [`ClientConfigurations`](../../models/core/interfaces/ClientConfigurations.md) + +#### Overrides + +Client.constructor + +#### Source + +client/apis/FraudPreventionV2Client.ts:54 + +## Methods + +### notifyWithAccountUpdate() + +> **notifyWithAccountUpdate**(`accountUpdateRequest`, `transactionId`): `Promise`\<[`AccountUpdateResponse`](../../models/classes/AccountUpdateResponse.md)\> + +Send an update as a result of an account screen transaction +The Account Update API is called when there is an account lifecycle transition such as a challenge outcome, account restoration, or remediation action completion. For example, if a user\'s account is disabled, deleted, or restored, the Account Update API is called to notify Expedia Group about the change. The Account Update API is also called when a user responds to a login Multi-Factor Authentication based on a Fraud recommendation. + +#### Parameters + +▪ **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` + +A unique ID to uniquely identify a request/response cycle (optional, defaults to a random generated UUID)`` + +#### Returns + +Promise + +#### Throws + +ExpediaGroupApiAccountTakeoverBadRequestError + +#### Throws + +ExpediaGroupApiAccountTakeoverUnauthorizedError + +#### Throws + +ExpediaGroupApiForbiddenError + +#### Throws + +ExpediaGroupApiAccountUpdateNotFoundError + +#### Throws + +ExpediaGroupApiTooManyRequestsError + +#### Throws + +ExpediaGroupApiInternalServerError + +#### Throws + +ExpediaGroupApiBadGatewayError + +#### Throws + +ExpediaGroupApiServiceUnavailableError + +#### Throws + +ExpediaGroupApiGatewayTimeoutError + +#### Source + +client/apis/FraudPreventionV2Client.ts:86 + +*** + +### notifyWithOrderUpdate() + +> **notifyWithOrderUpdate**(`orderPurchaseUpdateRequest`, `transactionId`): `Promise`\<[`OrderPurchaseUpdateResponse`](../../models/classes/OrderPurchaseUpdateResponse.md)\> + +Send an update for a transaction +The Order Purchase Update API is called when the status of the order has changed. For example, if the customer cancels the reservation, changes reservation in any way, or adds additional products or travelers to the reservation, the Order Purchase Update API is called to notify Expedia Group about the change. The Order Purchase Update API is also called when the merchant cancels or changes an order based on a Fraud recommendation. + +#### Parameters + +▪ **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` + +A unique ID to uniquely identify a request/response cycle (optional, defaults to a random generated UUID)`` + +#### Returns + +Promise + +#### Throws + +ExpediaGroupApiBadRequestError + +#### Throws + +ExpediaGroupApiUnauthorizedError + +#### Throws + +ExpediaGroupApiForbiddenError + +#### Throws + +ExpediaGroupApiOrderPurchaseUpdateNotFoundError + +#### Throws + +ExpediaGroupApiTooManyRequestsError + +#### Throws + +ExpediaGroupApiInternalServerError + +#### Throws + +ExpediaGroupApiBadGatewayError + +#### Throws + +ExpediaGroupApiRetryableOrderPurchaseUpdateFailure + +#### Throws + +ExpediaGroupApiGatewayTimeoutError + +#### Source + +client/apis/FraudPreventionV2Client.ts:129 + +*** + +### screenAccount() + +> **screenAccount**(`accountScreenRequest`, `transactionId`): `Promise`\<[`AccountScreenResponse`](../../models/classes/AccountScreenResponse.md)\> + +Run fraud screening for one transaction +The Account Screen API gives a Fraud recommendation for an account transaction. A recommendation can be ACCEPT, CHALLENGE, or REJECT. A transaction is marked as CHALLENGE whenever there are insufficient signals to recommend ACCEPT or REJECT. These CHALLENGE incidents are manually reviewed, and a corrected recommendation is made asynchronously. + +#### Parameters + +▪ **accountScreenRequest**: [`AccountScreenRequest`](../../models/classes/AccountScreenRequest.md) + +▪ **transactionId**: `string`= `undefined` + +A unique ID to uniquely identify a request/response cycle (optional, defaults to a random generated UUID)`` + +#### Returns + +Promise + +#### Throws + +ExpediaGroupApiAccountTakeoverBadRequestError + +#### Throws + +ExpediaGroupApiAccountTakeoverUnauthorizedError + +#### Throws + +ExpediaGroupApiForbiddenError + +#### Throws + +ExpediaGroupApiNotFoundError + +#### Throws + +ExpediaGroupApiTooManyRequestsError + +#### Throws + +ExpediaGroupApiInternalServerError + +#### Throws + +ExpediaGroupApiBadGatewayError + +#### Throws + +ExpediaGroupApiServiceUnavailableError + +#### Throws + +ExpediaGroupApiGatewayTimeoutError + +#### Source + +client/apis/FraudPreventionV2Client.ts:172 + +*** + +### screenOrder() + +> **screenOrder**(`orderPurchaseScreenRequest`, `transactionId`): `Promise`\<[`OrderPurchaseScreenResponse`](../../models/classes/OrderPurchaseScreenResponse.md)\> + +Run fraud screening for one transaction +The Order Purchase API gives a Fraud recommendation for a transaction. A recommendation can be Accept, Reject, or Review. A transaction is marked as Review whenever there are insufficient signals to recommend Accept or Reject. These incidents are manually reviewed, and a corrected recommendation is made asynchronously. + +#### Parameters + +▪ **orderPurchaseScreenRequest**: [`OrderPurchaseScreenRequest`](../../models/classes/OrderPurchaseScreenRequest.md) + +▪ **transactionId**: `string`= `undefined` + +A unique ID to uniquely identify a request/response cycle (optional, defaults to a random generated UUID)`` + +#### Returns + +Promise + +#### Throws + +ExpediaGroupApiBadRequestError + +#### Throws + +ExpediaGroupApiUnauthorizedError + +#### Throws + +ExpediaGroupApiForbiddenError + +#### Throws + +ExpediaGroupApiNotFoundError + +#### Throws + +ExpediaGroupApiTooManyRequestsError + +#### Throws + +ExpediaGroupApiInternalServerError + +#### Throws + +ExpediaGroupApiBadGatewayError + +#### Throws + +ExpediaGroupApiRetryableOrderPurchaseScreenFailure + +#### Throws + +ExpediaGroupApiGatewayTimeoutError + +#### Source + +client/apis/FraudPreventionV2Client.ts:212 diff --git a/release/fraudPreventionV2/docs/client/index.md b/release/fraudPreventionV2/src/docs/client/index.md similarity index 58% rename from release/fraudPreventionV2/docs/client/index.md rename to release/fraudPreventionV2/src/docs/client/index.md index e4e68ea9..199abed5 100644 --- a/release/fraudPreventionV2/docs/client/index.md +++ b/release/fraudPreventionV2/src/docs/client/index.md @@ -6,4 +6,4 @@ ### Classes -- [FraudPreventionV2Client](classes/class.FraudPreventionV2Client.md) +- [FraudPreventionV2Client](classes/FraudPreventionV2Client.md) diff --git a/release/fraudPreventionV2/src/docs/index.md b/release/fraudPreventionV2/src/docs/index.md new file mode 100644 index 00000000..dd21234e --- /dev/null +++ b/release/fraudPreventionV2/src/docs/index.md @@ -0,0 +1,8 @@ +# @expediagroup/fraudpreventionv2-sdk + +## Index + +### Modules + +- [client](client/index.md) +- [models](models/index.md) diff --git a/release/fraudPreventionV2/src/docs/models/classes/AccountScreenRequest.md b/release/fraudPreventionV2/src/docs/models/classes/AccountScreenRequest.md new file mode 100644 index 00000000..3a5cf27d --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/AccountScreenRequest.md @@ -0,0 +1,25 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountScreenRequest + +# Class: AccountScreenRequest + +Information for account screening by Expedia\'s Fraud Prevention Service. + +## Constructors + +### new AccountScreenRequest(accountScreenRequest) + +> **new AccountScreenRequest**(`accountScreenRequest`): [`AccountScreenRequest`](AccountScreenRequest.md) + +#### Parameters + +▪ **accountScreenRequest**: [`AccountScreenRequestProperties`](../interfaces/AccountScreenRequestProperties.md) + +#### Source + +models/AccountScreenRequest.ts:36 + +## Properties + +| Property | Type | Description | Source | +| :------ | :------ | :------ | :------ | +| `transaction` | [`AccountTransaction`](AccountTransaction.md) | - | models/AccountScreenRequest.ts:34 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/AccountScreenResponse.md b/release/fraudPreventionV2/src/docs/models/classes/AccountScreenResponse.md new file mode 100644 index 00000000..8f12fa1a --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/AccountScreenResponse.md @@ -0,0 +1,26 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountScreenResponse + +# Class: AccountScreenResponse + +Response for an account transaction provided by Expedia\'s Fraud Prevention Service. + +## Constructors + +### new AccountScreenResponse(accountScreenResponse) + +> **new AccountScreenResponse**(`accountScreenResponse`): [`AccountScreenResponse`](AccountScreenResponse.md) + +#### Parameters + +▪ **accountScreenResponse**: [`AccountScreenResponseProperties`](../interfaces/AccountScreenResponseProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/AccountTakeoverBadRequestError.md b/release/fraudPreventionV2/src/docs/models/classes/AccountTakeoverBadRequestError.md new file mode 100644 index 00000000..b8b5f666 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/AccountTakeoverBadRequestError.md @@ -0,0 +1,27 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountTakeoverBadRequestError + +# Class: AccountTakeoverBadRequestError + +Indicates that a bad request occurred. Typically it is an invalid parameter. + +## Constructors + +### new AccountTakeoverBadRequestError(accountTakeoverBadRequestError) + +> **new AccountTakeoverBadRequestError**(`accountTakeoverBadRequestError`): [`AccountTakeoverBadRequestError`](AccountTakeoverBadRequestError.md) + +#### Parameters + +▪ **accountTakeoverBadRequestError**: [`AccountTakeoverBadRequestErrorProperties`](../interfaces/AccountTakeoverBadRequestErrorProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/AccountTakeoverBadRequestErrorAllOfCauses.md b/release/fraudPreventionV2/src/docs/models/classes/AccountTakeoverBadRequestErrorAllOfCauses.md new file mode 100644 index 00000000..cd0ddb1d --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/AccountTakeoverBadRequestErrorAllOfCauses.md @@ -0,0 +1,25 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountTakeoverBadRequestErrorAllOfCauses + +# Class: AccountTakeoverBadRequestErrorAllOfCauses + +## Constructors + +### new AccountTakeoverBadRequestErrorAllOfCauses(accountTakeoverBadRequestErrorAllOfCauses) + +> **new AccountTakeoverBadRequestErrorAllOfCauses**(`accountTakeoverBadRequestErrorAllOfCauses`): [`AccountTakeoverBadRequestErrorAllOfCauses`](AccountTakeoverBadRequestErrorAllOfCauses.md) + +#### Parameters + +▪ **accountTakeoverBadRequestErrorAllOfCauses**: [`AccountTakeoverBadRequestErrorAllOfCausesProperties`](../interfaces/AccountTakeoverBadRequestErrorAllOfCausesProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/AccountTakeoverCustomerAccount.md b/release/fraudPreventionV2/src/docs/models/classes/AccountTakeoverCustomerAccount.md new file mode 100644 index 00000000..4644e9a3 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/AccountTakeoverCustomerAccount.md @@ -0,0 +1,35 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountTakeoverCustomerAccount + +# Class: AccountTakeoverCustomerAccount + +Information about a user\'s account. + +## Constructors + +### new AccountTakeoverCustomerAccount(accountTakeoverCustomerAccount) + +> **new AccountTakeoverCustomerAccount**(`accountTakeoverCustomerAccount`): [`AccountTakeoverCustomerAccount`](AccountTakeoverCustomerAccount.md) + +#### Parameters + +▪ **accountTakeoverCustomerAccount**: [`AccountTakeoverCustomerAccountProperties`](../interfaces/AccountTakeoverCustomerAccountProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/AccountTakeoverDeviceDetails.md b/release/fraudPreventionV2/src/docs/models/classes/AccountTakeoverDeviceDetails.md new file mode 100644 index 00000000..24dd0ecb --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/AccountTakeoverDeviceDetails.md @@ -0,0 +1,29 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountTakeoverDeviceDetails + +# Class: AccountTakeoverDeviceDetails + +Information specific to the Partner\'s device through which a transaction was made. + +## Constructors + +### new AccountTakeoverDeviceDetails(accountTakeoverDeviceDetails) + +> **new AccountTakeoverDeviceDetails**(`accountTakeoverDeviceDetails`): [`AccountTakeoverDeviceDetails`](AccountTakeoverDeviceDetails.md) + +#### Parameters + +▪ **accountTakeoverDeviceDetails**: [`AccountTakeoverDeviceDetailsProperties`](../interfaces/AccountTakeoverDeviceDetailsProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/AccountTakeoverError.md b/release/fraudPreventionV2/src/docs/models/classes/AccountTakeoverError.md new file mode 100644 index 00000000..7b93555a --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/AccountTakeoverError.md @@ -0,0 +1,26 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountTakeoverError + +# Class: AccountTakeoverError + +The object used to describe an error, containing both human-readable and machine-readable information. + +## Constructors + +### new AccountTakeoverError(accountTakeoverError) + +> **new AccountTakeoverError**(`accountTakeoverError`): [`AccountTakeoverError`](AccountTakeoverError.md) + +#### Parameters + +▪ **accountTakeoverError**: [`AccountTakeoverErrorProperties`](../interfaces/AccountTakeoverErrorProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/AccountTakeoverName.md b/release/fraudPreventionV2/src/docs/models/classes/AccountTakeoverName.md new file mode 100644 index 00000000..90498618 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/AccountTakeoverName.md @@ -0,0 +1,29 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountTakeoverName + +# Class: AccountTakeoverName + +Group of attributes intended to hold information about a customer or traveler\'\'s name for the account. + +## Constructors + +### new AccountTakeoverName(accountTakeoverName) + +> **new AccountTakeoverName**(`accountTakeoverName`): [`AccountTakeoverName`](AccountTakeoverName.md) + +#### Parameters + +▪ **accountTakeoverName**: [`AccountTakeoverNameProperties`](../interfaces/AccountTakeoverNameProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/AccountTakeoverSiteInfo.md b/release/fraudPreventionV2/src/docs/models/classes/AccountTakeoverSiteInfo.md new file mode 100644 index 00000000..71a16d0f --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/AccountTakeoverSiteInfo.md @@ -0,0 +1,28 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountTakeoverSiteInfo + +# Class: AccountTakeoverSiteInfo + +Information specific to the Partner\'s website through which a transaction was made. + +## Constructors + +### new AccountTakeoverSiteInfo(accountTakeoverSiteInfo) + +> **new AccountTakeoverSiteInfo**(`accountTakeoverSiteInfo`): [`AccountTakeoverSiteInfo`](AccountTakeoverSiteInfo.md) + +#### Parameters + +▪ **accountTakeoverSiteInfo**: [`AccountTakeoverSiteInfoProperties`](../interfaces/AccountTakeoverSiteInfoProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/AccountTakeoverTransactionDetails.md b/release/fraudPreventionV2/src/docs/models/classes/AccountTakeoverTransactionDetails.md new file mode 100644 index 00000000..1d526efb --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/AccountTakeoverTransactionDetails.md @@ -0,0 +1,31 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountTakeoverTransactionDetails + +# Class: AccountTakeoverTransactionDetails + +The `transaction_type` field value is used as a discriminator, with the following mapping: * `LOGIN`: `LoginTransactionDetails` + +## Extended By + +- [`LoginTransactionDetails`](LoginTransactionDetails.md) + +## Constructors + +### new AccountTakeoverTransactionDetails(accountTakeoverTransactionDetails) + +> **new AccountTakeoverTransactionDetails**(`accountTakeoverTransactionDetails`): [`AccountTakeoverTransactionDetails`](AccountTakeoverTransactionDetails.md) + +#### Parameters + +▪ **accountTakeoverTransactionDetails**: [`AccountTakeoverTransactionDetailsProperties`](../interfaces/AccountTakeoverTransactionDetailsProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/AccountTakeoverUnauthorizedError.md b/release/fraudPreventionV2/src/docs/models/classes/AccountTakeoverUnauthorizedError.md new file mode 100644 index 00000000..a75a80ac --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/AccountTakeoverUnauthorizedError.md @@ -0,0 +1,26 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountTakeoverUnauthorizedError + +# Class: AccountTakeoverUnauthorizedError + +Indicates that the token sent in the \'Authorization\' header is either invalid or missing. Please check the value in the token field along with the token expiration time before retrying. + +## Constructors + +### new AccountTakeoverUnauthorizedError(accountTakeoverUnauthorizedError) + +> **new AccountTakeoverUnauthorizedError**(`accountTakeoverUnauthorizedError`): [`AccountTakeoverUnauthorizedError`](AccountTakeoverUnauthorizedError.md) + +#### Parameters + +▪ **accountTakeoverUnauthorizedError**: [`AccountTakeoverUnauthorizedErrorProperties`](../interfaces/AccountTakeoverUnauthorizedErrorProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/AccountTransaction.md b/release/fraudPreventionV2/src/docs/models/classes/AccountTransaction.md new file mode 100644 index 00000000..5310910b --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/AccountTransaction.md @@ -0,0 +1,28 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountTransaction + +# Class: AccountTransaction + +Information for an account transaction. + +## Constructors + +### new AccountTransaction(accountTransaction) + +> **new AccountTransaction**(`accountTransaction`): [`AccountTransaction`](AccountTransaction.md) + +#### Parameters + +▪ **accountTransaction**: [`AccountTransactionProperties`](../interfaces/AccountTransactionProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/AccountUpdateNotFoundError.md b/release/fraudPreventionV2/src/docs/models/classes/AccountUpdateNotFoundError.md new file mode 100644 index 00000000..41513654 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/AccountUpdateNotFoundError.md @@ -0,0 +1,26 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountUpdateNotFoundError + +# Class: AccountUpdateNotFoundError + +Indicates that the API cannot find the resource that is either being requested or against which the operation is being performed. + +## Constructors + +### new AccountUpdateNotFoundError(accountUpdateNotFoundError) + +> **new AccountUpdateNotFoundError**(`accountUpdateNotFoundError`): [`AccountUpdateNotFoundError`](AccountUpdateNotFoundError.md) + +#### Parameters + +▪ **accountUpdateNotFoundError**: [`AccountUpdateNotFoundErrorProperties`](../interfaces/AccountUpdateNotFoundErrorProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/AccountUpdateRequest.md b/release/fraudPreventionV2/src/docs/models/classes/AccountUpdateRequest.md new file mode 100644 index 00000000..ec236013 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/AccountUpdateRequest.md @@ -0,0 +1,30 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountUpdateRequest + +# Class: AccountUpdateRequest + +The `type` field value is used as a discriminator, with the following mapping: * `MULTI_FACTOR_AUTHENTICATION_UPDATE`: `MultiFactorAuthenticationUpdate` * `REMEDIATION_UPDATE`: `RemediationUpdate` + +## Extended By + +- [`MultiFactorAuthenticationUpdate`](MultiFactorAuthenticationUpdate.md) +- [`RemediationUpdate`](RemediationUpdate.md) + +## Constructors + +### new AccountUpdateRequest(accountUpdateRequest) + +> **new AccountUpdateRequest**(`accountUpdateRequest`): [`AccountUpdateRequest`](AccountUpdateRequest.md) + +#### Parameters + +▪ **accountUpdateRequest**: [`AccountUpdateRequestProperties`](../interfaces/AccountUpdateRequestProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/AccountUpdateResponse.md b/release/fraudPreventionV2/src/docs/models/classes/AccountUpdateResponse.md new file mode 100644 index 00000000..044dbed0 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/AccountUpdateResponse.md @@ -0,0 +1,23 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountUpdateResponse + +# Class: AccountUpdateResponse + +## Constructors + +### new AccountUpdateResponse(accountUpdateResponse) + +> **new AccountUpdateResponse**(`accountUpdateResponse`): [`AccountUpdateResponse`](AccountUpdateResponse.md) + +#### Parameters + +▪ **accountUpdateResponse**: [`AccountUpdateResponseProperties`](../interfaces/AccountUpdateResponseProperties.md) + +#### Source + +models/AccountUpdateResponse.ts:31 + +## Properties + +| Property | Type | Description | Source | +| :------ | :------ | :------ | :------ | +| `riskId?` | `string` | Unique identifier of transaction that was updated. | models/AccountUpdateResponse.ts:29 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/Address.md b/release/fraudPreventionV2/src/docs/models/classes/Address.md new file mode 100644 index 00000000..1e97f354 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/Address.md @@ -0,0 +1,29 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > Address + +# Class: Address + +## Constructors + +### new Address(address) + +> **new Address**(`address`): [`Address`](Address.md) + +#### Parameters + +▪ **address**: [`AddressProperties`](../interfaces/AddressProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/Air.md b/release/fraudPreventionV2/src/docs/models/classes/Air.md new file mode 100644 index 00000000..0dfd7ff5 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/Air.md @@ -0,0 +1,44 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > Air + +# Class: Air + +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` + +## Extends + +- [`TravelProduct`](TravelProduct.md) + +## Constructors + +### new Air(air) + +> **new Air**(`air`): [`Air`](Air.md) + +#### Parameters + +▪ **air**: [`AirProperties`](../interfaces/AirProperties.md) + +#### Overrides + +[`TravelProduct`](TravelProduct.md).[`constructor`](TravelProduct.md#constructors) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/AirSegment.md b/release/fraudPreventionV2/src/docs/models/classes/AirSegment.md new file mode 100644 index 00000000..56694301 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/AirSegment.md @@ -0,0 +1,27 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AirSegment + +# Class: AirSegment + +## Constructors + +### new AirSegment(airSegment) + +> **new AirSegment**(`airSegment`): [`AirSegment`](AirSegment.md) + +#### Parameters + +▪ **airSegment**: [`AirSegmentProperties`](../interfaces/AirSegmentProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/Amount.md b/release/fraudPreventionV2/src/docs/models/classes/Amount.md new file mode 100644 index 00000000..f48af33c --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/Amount.md @@ -0,0 +1,24 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > Amount + +# Class: Amount + +## Constructors + +### new Amount(amount) + +> **new Amount**(`amount`): [`Amount`](Amount.md) + +#### Parameters + +▪ **amount**: [`AmountProperties`](../interfaces/AmountProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/Authorize.md b/release/fraudPreventionV2/src/docs/models/classes/Authorize.md new file mode 100644 index 00000000..88c3f88e --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/Authorize.md @@ -0,0 +1,27 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > Authorize + +# Class: Authorize + +Authorize operation on the payment. An authorize operation represents placing the funds on hold with the specified form of payment. + +## Constructors + +### new Authorize(authorize) + +> **new Authorize**(`authorize`): [`Authorize`](Authorize.md) + +#### Parameters + +▪ **authorize**: [`AuthorizeProperties`](../interfaces/AuthorizeProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/AuthorizeReversal.md b/release/fraudPreventionV2/src/docs/models/classes/AuthorizeReversal.md new file mode 100644 index 00000000..eac58644 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/AuthorizeReversal.md @@ -0,0 +1,27 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AuthorizeReversal + +# Class: AuthorizeReversal + +Authorize Reversal operation on the payment. An authorize reversal operation represents a notification received usually from a 3rd party payment processor to indicate that an authorization hold should be released as a result of a sale being partially or completely cancelled. + +## Constructors + +### new AuthorizeReversal(authorizeReversal) + +> **new AuthorizeReversal**(`authorizeReversal`): [`AuthorizeReversal`](AuthorizeReversal.md) + +#### Parameters + +▪ **authorizeReversal**: [`AuthorizeReversalProperties`](../interfaces/AuthorizeReversalProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/BadGatewayError.md b/release/fraudPreventionV2/src/docs/models/classes/BadGatewayError.md new file mode 100644 index 00000000..d2b31c0a --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/BadGatewayError.md @@ -0,0 +1,26 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > BadGatewayError + +# Class: BadGatewayError + +Indicates that the server received an invalid response from the upstream server. Causes could be incorrectly configured target server at gateway, EOF exception, incorrectly configured keep-alive timeouts. Please reach out to support team as next step for this error resolution. + +## Constructors + +### new BadGatewayError(badGatewayError) + +> **new BadGatewayError**(`badGatewayError`): [`BadGatewayError`](BadGatewayError.md) + +#### Parameters + +▪ **badGatewayError**: [`BadGatewayErrorProperties`](../interfaces/BadGatewayErrorProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/BadRequestError.md b/release/fraudPreventionV2/src/docs/models/classes/BadRequestError.md new file mode 100644 index 00000000..95cefbc3 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/BadRequestError.md @@ -0,0 +1,27 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > BadRequestError + +# Class: BadRequestError + +Indicates that a bad request occurred. Typically it is an invalid parameter. + +## Constructors + +### new BadRequestError(badRequestError) + +> **new BadRequestError**(`badRequestError`): [`BadRequestError`](BadRequestError.md) + +#### Parameters + +▪ **badRequestError**: [`BadRequestErrorProperties`](../interfaces/BadRequestErrorProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/BadRequestErrorAllOfCauses.md b/release/fraudPreventionV2/src/docs/models/classes/BadRequestErrorAllOfCauses.md new file mode 100644 index 00000000..46175e3a --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/BadRequestErrorAllOfCauses.md @@ -0,0 +1,25 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > BadRequestErrorAllOfCauses + +# Class: BadRequestErrorAllOfCauses + +## Constructors + +### new BadRequestErrorAllOfCauses(badRequestErrorAllOfCauses) + +> **new BadRequestErrorAllOfCauses**(`badRequestErrorAllOfCauses`): [`BadRequestErrorAllOfCauses`](BadRequestErrorAllOfCauses.md) + +#### Parameters + +▪ **badRequestErrorAllOfCauses**: [`BadRequestErrorAllOfCausesProperties`](../interfaces/BadRequestErrorAllOfCausesProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/CancellationReason.md b/release/fraudPreventionV2/src/docs/models/classes/CancellationReason.md new file mode 100644 index 00000000..b730f7df --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/CancellationReason.md @@ -0,0 +1,28 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > CancellationReason + +# Class: CancellationReason + +Reason of order update cancellation. + +## Constructors + +### new CancellationReason(cancellationReason) + +> **new CancellationReason**(`cancellationReason`): [`CancellationReason`](CancellationReason.md) + +#### Parameters + +▪ **cancellationReason**: [`CancellationReasonProperties`](../interfaces/CancellationReasonProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/Capture.md b/release/fraudPreventionV2/src/docs/models/classes/Capture.md new file mode 100644 index 00000000..f83988aa --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/Capture.md @@ -0,0 +1,27 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > Capture + +# Class: Capture + +Capture operation on the payment. A capture operation represents a notification received usually from a 3rd party payment processor to indicate that the funds placed on hold will be captured and the funds transfer process will occur from the customer\'s funds to the merchant\'s funds. + +## Constructors + +### new Capture(capture) + +> **new Capture**(`capture`): [`Capture`](Capture.md) + +#### Parameters + +▪ **capture**: [`CaptureProperties`](../interfaces/CaptureProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/Car.md b/release/fraudPreventionV2/src/docs/models/classes/Car.md new file mode 100644 index 00000000..be700efb --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/Car.md @@ -0,0 +1,42 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > Car + +# Class: Car + +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` + +## Extends + +- [`TravelProduct`](TravelProduct.md) + +## Constructors + +### new Car(car) + +> **new Car**(`car`): [`Car`](Car.md) + +#### Parameters + +▪ **car**: [`CarProperties`](../interfaces/CarProperties.md) + +#### Overrides + +[`TravelProduct`](TravelProduct.md).[`constructor`](TravelProduct.md#constructors) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/ChallengeDetail.md b/release/fraudPreventionV2/src/docs/models/classes/ChallengeDetail.md new file mode 100644 index 00000000..4e123f70 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/ChallengeDetail.md @@ -0,0 +1,27 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > ChallengeDetail + +# Class: ChallengeDetail + +Information related to challenges initiated by the Partner\'s system to a user before calling Expedia\'s Fraud Prevention Service. + +## Constructors + +### new ChallengeDetail(challengeDetail) + +> **new ChallengeDetail**(`challengeDetail`): [`ChallengeDetail`](ChallengeDetail.md) + +#### Parameters + +▪ **challengeDetail**: [`ChallengeDetailProperties`](../interfaces/ChallengeDetailProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/ChargebackDetail.md b/release/fraudPreventionV2/src/docs/models/classes/ChargebackDetail.md new file mode 100644 index 00000000..f2727cdc --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/ChargebackDetail.md @@ -0,0 +1,29 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > ChargebackDetail + +# Class: ChargebackDetail + +Details related to the chargeback. + +## Constructors + +### new ChargebackDetail(chargebackDetail) + +> **new ChargebackDetail**(`chargebackDetail`): [`ChargebackDetail`](ChargebackDetail.md) + +#### Parameters + +▪ **chargebackDetail**: [`ChargebackDetailProperties`](../interfaces/ChargebackDetailProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/ChargebackFeedback.md b/release/fraudPreventionV2/src/docs/models/classes/ChargebackFeedback.md new file mode 100644 index 00000000..bec94dcf --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/ChargebackFeedback.md @@ -0,0 +1,35 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > ChargebackFeedback + +# Class: ChargebackFeedback + +Feedback from EG external partners if they receive a chargeback for a false negative recommendation from Fraud Prevention system. + +## Extends + +- [`OrderPurchaseUpdateRequest`](OrderPurchaseUpdateRequest.md) + +## Constructors + +### new ChargebackFeedback(chargebackFeedback) + +> **new ChargebackFeedback**(`chargebackFeedback`): [`ChargebackFeedback`](ChargebackFeedback.md) + +#### Parameters + +▪ **chargebackFeedback**: [`ChargebackFeedbackProperties`](../interfaces/ChargebackFeedbackProperties.md) + +#### Overrides + +[`OrderPurchaseUpdateRequest`](OrderPurchaseUpdateRequest.md).[`constructor`](OrderPurchaseUpdateRequest.md#constructors) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/CreditCard.md b/release/fraudPreventionV2/src/docs/models/classes/CreditCard.md new file mode 100644 index 00000000..7bedddb1 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/CreditCard.md @@ -0,0 +1,53 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > CreditCard + +# Class: CreditCard + +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` + +## Extends + +- [`Payment`](Payment.md) + +## Constructors + +### new CreditCard(creditCard) + +> **new CreditCard**(`creditCard`): [`CreditCard`](CreditCard.md) + +#### Parameters + +▪ **creditCard**: [`CreditCardProperties`](../interfaces/CreditCardProperties.md) + +#### Overrides + +[`Payment`](Payment.md).[`constructor`](Payment.md#constructors) + +#### Source + +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` * `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` * `UATP` * `UATP_SUPPLY` * `AIR_PLUS` * `US_PASS_PLUS` \'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` | [`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` * `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` | `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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/Cruise.md b/release/fraudPreventionV2/src/docs/models/classes/Cruise.md new file mode 100644 index 00000000..464963c1 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/Cruise.md @@ -0,0 +1,43 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > Cruise + +# Class: Cruise + +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` + +## Extends + +- [`TravelProduct`](TravelProduct.md) + +## Constructors + +### new Cruise(cruise) + +> **new Cruise**(`cruise`): [`Cruise`](Cruise.md) + +#### Parameters + +▪ **cruise**: [`CruiseProperties`](../interfaces/CruiseProperties.md) + +#### Overrides + +[`TravelProduct`](TravelProduct.md).[`constructor`](TravelProduct.md#constructors) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/CurrentUserSession.md b/release/fraudPreventionV2/src/docs/models/classes/CurrentUserSession.md new file mode 100644 index 00000000..a77237d1 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/CurrentUserSession.md @@ -0,0 +1,27 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > CurrentUserSession + +# Class: CurrentUserSession + +The current user session prior to this transaction, which contains details related to any challenge initiated by the Partner\'\'s system to a user before calling Expedia\'\'s Fraud Prevention Service. An example is if the Partner\'\'s system sent a Captcha challenge to the user before calling Expedia\'\'s Fraud Prevention Service. + +## Constructors + +### new CurrentUserSession(currentUserSession) + +> **new CurrentUserSession**(`currentUserSession`): [`CurrentUserSession`](CurrentUserSession.md) + +#### Parameters + +▪ **currentUserSession**: [`CurrentUserSessionProperties`](../interfaces/CurrentUserSessionProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/CustomerAccount.md b/release/fraudPreventionV2/src/docs/models/classes/CustomerAccount.md new file mode 100644 index 00000000..25d8450f --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/CustomerAccount.md @@ -0,0 +1,29 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > CustomerAccount + +# Class: CustomerAccount + +## Constructors + +### new CustomerAccount(customerAccount) + +> **new CustomerAccount**(`customerAccount`): [`CustomerAccount`](CustomerAccount.md) + +#### Parameters + +▪ **customerAccount**: [`CustomerAccountProperties`](../interfaces/CustomerAccountProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/CustomerAccountAddress.md b/release/fraudPreventionV2/src/docs/models/classes/CustomerAccountAddress.md new file mode 100644 index 00000000..62c5b885 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/CustomerAccountAddress.md @@ -0,0 +1,29 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > CustomerAccountAddress + +# Class: CustomerAccountAddress + +## Constructors + +### new CustomerAccountAddress(customerAccountAddress) + +> **new CustomerAccountAddress**(`customerAccountAddress`): [`CustomerAccountAddress`](CustomerAccountAddress.md) + +#### Parameters + +▪ **customerAccountAddress**: [`CustomerAccountAddressProperties`](../interfaces/CustomerAccountAddressProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/DeviceDetails.md b/release/fraudPreventionV2/src/docs/models/classes/DeviceDetails.md new file mode 100644 index 00000000..532ad2d5 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/DeviceDetails.md @@ -0,0 +1,25 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > DeviceDetails + +# Class: DeviceDetails + +## Constructors + +### new DeviceDetails(deviceDetails) + +> **new DeviceDetails**(`deviceDetails`): [`DeviceDetails`](DeviceDetails.md) + +#### Parameters + +▪ **deviceDetails**: [`DeviceDetailsProperties`](../interfaces/DeviceDetailsProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/DirectDebit.md b/release/fraudPreventionV2/src/docs/models/classes/DirectDebit.md new file mode 100644 index 00000000..43351dd4 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/DirectDebit.md @@ -0,0 +1,45 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > DirectDebit + +# Class: DirectDebit + +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` + +## Extends + +- [`Payment`](Payment.md) + +## Constructors + +### new DirectDebit(directDebit) + +> **new DirectDebit**(`directDebit`): [`DirectDebit`](DirectDebit.md) + +#### Parameters + +▪ **directDebit**: [`DirectDebitProperties`](../interfaces/DirectDebitProperties.md) + +#### Overrides + +[`Payment`](Payment.md).[`constructor`](Payment.md#constructors) + +#### Source + +models/DirectDebit.ts:52 + +## 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` * `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` * `UATP` * `UATP_SUPPLY` * `AIR_PLUS` * `US_PASS_PLUS` \'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` | [`Payment`](Payment.md).`brand` | models/Payment.ts:48 | +| `readonly` | `method` | `"DIRECT_DEBIT"` | - | - | models/DirectDebit.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` | `routingNumber` | `string` | A code that identifies the financial institution for a specific bank account. | - | models/DirectDebit.ts:34 | +| `public` | `telephones` | [`Telephone`](Telephone.md)[] | Telephone(s) associated with direct debit payment provider. | - | models/DirectDebit.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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/Email.md b/release/fraudPreventionV2/src/docs/models/classes/Email.md new file mode 100644 index 00000000..2ccc612a --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/Email.md @@ -0,0 +1,25 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > Email + +# Class: Email + +Group of attributes intended to hold information about email address associated with the transaction. + +## Constructors + +### new Email(email) + +> **new Email**(`email`): [`Email`](Email.md) + +#### Parameters + +▪ **email**: [`EmailProperties`](../interfaces/EmailProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/ForbiddenError.md b/release/fraudPreventionV2/src/docs/models/classes/ForbiddenError.md new file mode 100644 index 00000000..b5aa0f09 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/ForbiddenError.md @@ -0,0 +1,26 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > ForbiddenError + +# Class: ForbiddenError + +Indicates that the API cannot fulfill the request because while the client is correctly authenticated, the client doesn\'t have the permission to execute the specified operation. This error type does not imply that the request is valid, or that the resource against which the operation being performed exists or satisfies other pre-conditions. + +## Constructors + +### new ForbiddenError(forbiddenError) + +> **new ForbiddenError**(`forbiddenError`): [`ForbiddenError`](ForbiddenError.md) + +#### Parameters + +▪ **forbiddenError**: [`ForbiddenErrorProperties`](../interfaces/ForbiddenErrorProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/GatewayTimeoutError.md b/release/fraudPreventionV2/src/docs/models/classes/GatewayTimeoutError.md new file mode 100644 index 00000000..87baed96 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/GatewayTimeoutError.md @@ -0,0 +1,26 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > GatewayTimeoutError + +# 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. + +## Constructors + +### new GatewayTimeoutError(gatewayTimeoutError) + +> **new GatewayTimeoutError**(`gatewayTimeoutError`): [`GatewayTimeoutError`](GatewayTimeoutError.md) + +#### Parameters + +▪ **gatewayTimeoutError**: [`GatewayTimeoutErrorProperties`](../interfaces/GatewayTimeoutErrorProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/GiftCard.md b/release/fraudPreventionV2/src/docs/models/classes/GiftCard.md new file mode 100644 index 00000000..1f687c6b --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/GiftCard.md @@ -0,0 +1,45 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > GiftCard + +# Class: GiftCard + +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` + +## Extends + +- [`Payment`](Payment.md) + +## Constructors + +### new GiftCard(giftCard) + +> **new GiftCard**(`giftCard`): [`GiftCard`](GiftCard.md) + +#### Parameters + +▪ **giftCard**: [`GiftCardProperties`](../interfaces/GiftCardProperties.md) + +#### Overrides + +[`Payment`](Payment.md).[`constructor`](Payment.md#constructors) + +#### Source + +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` * `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` * `UATP` * `UATP_SUPPLY` * `AIR_PLUS` * `US_PASS_PLUS` \'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` | [`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 | +| `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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/Hotel.md b/release/fraudPreventionV2/src/docs/models/classes/Hotel.md new file mode 100644 index 00000000..8d4c7522 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/Hotel.md @@ -0,0 +1,45 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > Hotel + +# Class: Hotel + +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` + +## Extends + +- [`TravelProduct`](TravelProduct.md) + +## Constructors + +### new Hotel(hotel) + +> **new Hotel**(`hotel`): [`Hotel`](Hotel.md) + +#### Parameters + +▪ **hotel**: [`HotelProperties`](../interfaces/HotelProperties.md) + +#### Overrides + +[`TravelProduct`](TravelProduct.md).[`constructor`](TravelProduct.md#constructors) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/HotelAddress.md b/release/fraudPreventionV2/src/docs/models/classes/HotelAddress.md new file mode 100644 index 00000000..77961e66 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/HotelAddress.md @@ -0,0 +1,31 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > HotelAddress + +# Class: HotelAddress + +Address of a hotel. + +## Constructors + +### new HotelAddress(hotelAddress) + +> **new HotelAddress**(`hotelAddress`): [`HotelAddress`](HotelAddress.md) + +#### Parameters + +▪ **hotelAddress**: [`HotelAddressProperties`](../interfaces/HotelAddressProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/InsultDetail.md b/release/fraudPreventionV2/src/docs/models/classes/InsultDetail.md new file mode 100644 index 00000000..e0f14106 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/InsultDetail.md @@ -0,0 +1,25 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > InsultDetail + +# Class: InsultDetail + +Details related to the insult. + +## Constructors + +### new InsultDetail(insultDetail) + +> **new InsultDetail**(`insultDetail`): [`InsultDetail`](InsultDetail.md) + +#### Parameters + +▪ **insultDetail**: [`InsultDetailProperties`](../interfaces/InsultDetailProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/InsultFeedback.md b/release/fraudPreventionV2/src/docs/models/classes/InsultFeedback.md new file mode 100644 index 00000000..e8c69cfc --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/InsultFeedback.md @@ -0,0 +1,35 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > InsultFeedback + +# Class: InsultFeedback + +Feedback from EG external partners regarding a false positive recommendation that from Fraud Prevention system gave for their customer. + +## Extends + +- [`OrderPurchaseUpdateRequest`](OrderPurchaseUpdateRequest.md) + +## Constructors + +### new InsultFeedback(insultFeedback) + +> **new InsultFeedback**(`insultFeedback`): [`InsultFeedback`](InsultFeedback.md) + +#### Parameters + +▪ **insultFeedback**: [`InsultFeedbackProperties`](../interfaces/InsultFeedbackProperties.md) + +#### Overrides + +[`OrderPurchaseUpdateRequest`](OrderPurchaseUpdateRequest.md).[`constructor`](OrderPurchaseUpdateRequest.md#constructors) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/Insurance.md b/release/fraudPreventionV2/src/docs/models/classes/Insurance.md new file mode 100644 index 00000000..74df10db --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/Insurance.md @@ -0,0 +1,38 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > Insurance + +# Class: Insurance + +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` + +## Extends + +- [`TravelProduct`](TravelProduct.md) + +## Constructors + +### new Insurance(insurance) + +> **new Insurance**(`insurance`): [`Insurance`](Insurance.md) + +#### Parameters + +▪ **insurance**: [`InsuranceProperties`](../interfaces/InsuranceProperties.md) + +#### Overrides + +[`TravelProduct`](TravelProduct.md).[`constructor`](TravelProduct.md#constructors) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/InternalServerError.md b/release/fraudPreventionV2/src/docs/models/classes/InternalServerError.md new file mode 100644 index 00000000..c4e2af2b --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/InternalServerError.md @@ -0,0 +1,26 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > InternalServerError + +# Class: InternalServerError + +Indicates that the API encountered an unexpected condition that prevented it from fulfilling the request. Sometimes used as a generic catch-allerror type when no other error types can be used. Retrying the same request will usually result in the same error. Please reach out to support team as next step for this error resolution. + +## Constructors + +### new InternalServerError(internalServerError) + +> **new InternalServerError**(`internalServerError`): [`InternalServerError`](InternalServerError.md) + +#### Parameters + +▪ **internalServerError**: [`InternalServerErrorProperties`](../interfaces/InternalServerErrorProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/InternetBankPayment.md b/release/fraudPreventionV2/src/docs/models/classes/InternetBankPayment.md new file mode 100644 index 00000000..81e4f3e6 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/InternetBankPayment.md @@ -0,0 +1,45 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > InternetBankPayment + +# Class: InternetBankPayment + +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` + +## Extends + +- [`Payment`](Payment.md) + +## Constructors + +### new InternetBankPayment(internetBankPayment) + +> **new InternetBankPayment**(`internetBankPayment`): [`InternetBankPayment`](InternetBankPayment.md) + +#### Parameters + +▪ **internetBankPayment**: [`InternetBankPaymentProperties`](../interfaces/InternetBankPaymentProperties.md) + +#### Overrides + +[`Payment`](Payment.md).[`constructor`](Payment.md#constructors) + +#### Source + +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` * `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` * `UATP` * `UATP_SUPPLY` * `AIR_PLUS` * `US_PASS_PLUS` \'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` | [`Payment`](Payment.md).`brand` | models/Payment.ts:48 | +| `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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/IssuedRefundUpdate.md b/release/fraudPreventionV2/src/docs/models/classes/IssuedRefundUpdate.md new file mode 100644 index 00000000..c73f4738 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/IssuedRefundUpdate.md @@ -0,0 +1,36 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > IssuedRefundUpdate + +# Class: IssuedRefundUpdate + +Data related to the issued refund that should be updated. + +## Extends + +- [`RefundUpdate`](RefundUpdate.md) + +## Constructors + +### new IssuedRefundUpdate(issuedRefundUpdate) + +> **new IssuedRefundUpdate**(`issuedRefundUpdate`): [`IssuedRefundUpdate`](IssuedRefundUpdate.md) + +#### Parameters + +▪ **issuedRefundUpdate**: [`IssuedRefundUpdateProperties`](../interfaces/IssuedRefundUpdateProperties.md) + +#### Overrides + +[`RefundUpdate`](RefundUpdate.md).[`constructor`](RefundUpdate.md#constructors) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/IssuedRefundUpdateDetails.md b/release/fraudPreventionV2/src/docs/models/classes/IssuedRefundUpdateDetails.md new file mode 100644 index 00000000..c21dadf8 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/IssuedRefundUpdateDetails.md @@ -0,0 +1,26 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > IssuedRefundUpdateDetails + +# Class: IssuedRefundUpdateDetails + +Data that describes issued refund that should be updated. + +## Constructors + +### new IssuedRefundUpdateDetails(issuedRefundUpdateDetails) + +> **new IssuedRefundUpdateDetails**(`issuedRefundUpdateDetails`): [`IssuedRefundUpdateDetails`](IssuedRefundUpdateDetails.md) + +#### Parameters + +▪ **issuedRefundUpdateDetails**: [`IssuedRefundUpdateDetailsProperties`](../interfaces/IssuedRefundUpdateDetailsProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/LoginTransactionDetails.md b/release/fraudPreventionV2/src/docs/models/classes/LoginTransactionDetails.md new file mode 100644 index 00000000..b9282a9f --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/LoginTransactionDetails.md @@ -0,0 +1,40 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > LoginTransactionDetails + +# Class: LoginTransactionDetails + +The `transaction_type` field value is used as a discriminator, with the following mapping: * `LOGIN`: `LoginTransactionDetails` + +## Extends + +- [`AccountTakeoverTransactionDetails`](AccountTakeoverTransactionDetails.md) + +## Constructors + +### new LoginTransactionDetails(loginTransactionDetails) + +> **new LoginTransactionDetails**(`loginTransactionDetails`): [`LoginTransactionDetails`](LoginTransactionDetails.md) + +#### Parameters + +▪ **loginTransactionDetails**: [`LoginTransactionDetailsProperties`](../interfaces/LoginTransactionDetailsProperties.md) + +#### Overrides + +[`AccountTakeoverTransactionDetails`](AccountTakeoverTransactionDetails.md).[`constructor`](AccountTakeoverTransactionDetails.md#constructors) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/ModelError.md b/release/fraudPreventionV2/src/docs/models/classes/ModelError.md new file mode 100644 index 00000000..0e73edb4 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/ModelError.md @@ -0,0 +1,26 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > ModelError + +# Class: ModelError + +The object used to describe an error, containing both human-readable and machine-readable information. + +## Constructors + +### new ModelError(error) + +> **new ModelError**(`error`): [`ModelError`](ModelError.md) + +#### Parameters + +▪ **error**: [`ModelErrorProperties`](../interfaces/ModelErrorProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/MultiFactorAuthenticationAttempt.md b/release/fraudPreventionV2/src/docs/models/classes/MultiFactorAuthenticationAttempt.md new file mode 100644 index 00000000..24b690b0 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/MultiFactorAuthenticationAttempt.md @@ -0,0 +1,33 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > MultiFactorAuthenticationAttempt + +# Class: MultiFactorAuthenticationAttempt + +Information specific to the update event by a user. + +## Constructors + +### new MultiFactorAuthenticationAttempt(multiFactorAuthenticationAttempt) + +> **new MultiFactorAuthenticationAttempt**(`multiFactorAuthenticationAttempt`): [`MultiFactorAuthenticationAttempt`](MultiFactorAuthenticationAttempt.md) + +#### Parameters + +▪ **multiFactorAuthenticationAttempt**: [`MultiFactorAuthenticationAttemptProperties`](../interfaces/MultiFactorAuthenticationAttemptProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/MultiFactorAuthenticationUpdate.md b/release/fraudPreventionV2/src/docs/models/classes/MultiFactorAuthenticationUpdate.md new file mode 100644 index 00000000..94be2e0c --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/MultiFactorAuthenticationUpdate.md @@ -0,0 +1,35 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > MultiFactorAuthenticationUpdate + +# Class: MultiFactorAuthenticationUpdate + +Information specific to a user\'s response to a Multi-Factor Authentication initiated by the Partner\'s system as a result of a fraud recommendation. + +## Extends + +- [`AccountUpdateRequest`](AccountUpdateRequest.md) + +## Constructors + +### new MultiFactorAuthenticationUpdate(multiFactorAuthenticationUpdate) + +> **new MultiFactorAuthenticationUpdate**(`multiFactorAuthenticationUpdate`): [`MultiFactorAuthenticationUpdate`](MultiFactorAuthenticationUpdate.md) + +#### Parameters + +▪ **multiFactorAuthenticationUpdate**: [`MultiFactorAuthenticationUpdateProperties`](../interfaces/MultiFactorAuthenticationUpdateProperties.md) + +#### Overrides + +[`AccountUpdateRequest`](AccountUpdateRequest.md).[`constructor`](AccountUpdateRequest.md#constructors) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/Name.md b/release/fraudPreventionV2/src/docs/models/classes/Name.md new file mode 100644 index 00000000..3f67ebe0 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/Name.md @@ -0,0 +1,29 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > Name + +# Class: Name + +Group of attributes intended to hold information about a customer or traveler\'s name for the order. + +## Constructors + +### new Name(name) + +> **new Name**(`name`): [`Name`](Name.md) + +#### Parameters + +▪ **name**: [`NameProperties`](../interfaces/NameProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/NotFoundError.md b/release/fraudPreventionV2/src/docs/models/classes/NotFoundError.md new file mode 100644 index 00000000..156efc61 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/NotFoundError.md @@ -0,0 +1,26 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > NotFoundError + +# Class: NotFoundError + +Indicates that the API cannot find the resource that is either being requested or against which the operation is being performed. Please check the request again to make sure that the request is valid. + +## Constructors + +### new NotFoundError(notFoundError) + +> **new NotFoundError**(`notFoundError`): [`NotFoundError`](NotFoundError.md) + +#### Parameters + +▪ **notFoundError**: [`NotFoundErrorProperties`](../interfaces/NotFoundErrorProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/Operations.md b/release/fraudPreventionV2/src/docs/models/classes/Operations.md new file mode 100644 index 00000000..62ecf445 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/Operations.md @@ -0,0 +1,29 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > Operations + +# Class: Operations + +All operations related to a payment throughout its lifespan. An operation represents an event external to Fraud Prevention Service that specifies to perform a payment operation. Possible operation types include: - `Verify` - `Authorize` - `AuthorizeReversal` - `Capture` - `Refund` + +## Constructors + +### new Operations(operations) + +> **new Operations**(`operations`): [`Operations`](Operations.md) + +#### Parameters + +▪ **operations**: [`OperationsProperties`](../interfaces/OperationsProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/OrderPurchaseScreenRequest.md b/release/fraudPreventionV2/src/docs/models/classes/OrderPurchaseScreenRequest.md new file mode 100644 index 00000000..8e303bf7 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/OrderPurchaseScreenRequest.md @@ -0,0 +1,23 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > OrderPurchaseScreenRequest + +# Class: OrderPurchaseScreenRequest + +## Constructors + +### new OrderPurchaseScreenRequest(orderPurchaseScreenRequest) + +> **new OrderPurchaseScreenRequest**(`orderPurchaseScreenRequest`): [`OrderPurchaseScreenRequest`](OrderPurchaseScreenRequest.md) + +#### Parameters + +▪ **orderPurchaseScreenRequest**: [`OrderPurchaseScreenRequestProperties`](../interfaces/OrderPurchaseScreenRequestProperties.md) + +#### Source + +models/OrderPurchaseScreenRequest.ts:33 + +## Properties + +| Property | Type | Description | Source | +| :------ | :------ | :------ | :------ | +| `transaction` | [`OrderPurchaseTransaction`](OrderPurchaseTransaction.md) | - | models/OrderPurchaseScreenRequest.ts:31 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/OrderPurchaseScreenResponse.md b/release/fraudPreventionV2/src/docs/models/classes/OrderPurchaseScreenResponse.md new file mode 100644 index 00000000..9c9db1e1 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/OrderPurchaseScreenResponse.md @@ -0,0 +1,24 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > OrderPurchaseScreenResponse + +# Class: OrderPurchaseScreenResponse + +## Constructors + +### new OrderPurchaseScreenResponse(orderPurchaseScreenResponse) + +> **new OrderPurchaseScreenResponse**(`orderPurchaseScreenResponse`): [`OrderPurchaseScreenResponse`](OrderPurchaseScreenResponse.md) + +#### Parameters + +▪ **orderPurchaseScreenResponse**: [`OrderPurchaseScreenResponseProperties`](../interfaces/OrderPurchaseScreenResponseProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/OrderPurchaseTransaction.md b/release/fraudPreventionV2/src/docs/models/classes/OrderPurchaseTransaction.md new file mode 100644 index 00000000..a95c8ebf --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/OrderPurchaseTransaction.md @@ -0,0 +1,26 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > OrderPurchaseTransaction + +# Class: OrderPurchaseTransaction + +## Constructors + +### new OrderPurchaseTransaction(orderPurchaseTransaction) + +> **new OrderPurchaseTransaction**(`orderPurchaseTransaction`): [`OrderPurchaseTransaction`](OrderPurchaseTransaction.md) + +#### Parameters + +▪ **orderPurchaseTransaction**: [`OrderPurchaseTransactionProperties`](../interfaces/OrderPurchaseTransactionProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/OrderPurchaseUpdateNotFoundError.md b/release/fraudPreventionV2/src/docs/models/classes/OrderPurchaseUpdateNotFoundError.md new file mode 100644 index 00000000..e54a0219 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/OrderPurchaseUpdateNotFoundError.md @@ -0,0 +1,26 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > OrderPurchaseUpdateNotFoundError + +# Class: OrderPurchaseUpdateNotFoundError + +Indicates that the API cannot find the resource that is either being requested or against which the operation is being performed. + +## Constructors + +### new OrderPurchaseUpdateNotFoundError(orderPurchaseUpdateNotFoundError) + +> **new OrderPurchaseUpdateNotFoundError**(`orderPurchaseUpdateNotFoundError`): [`OrderPurchaseUpdateNotFoundError`](OrderPurchaseUpdateNotFoundError.md) + +#### Parameters + +▪ **orderPurchaseUpdateNotFoundError**: [`OrderPurchaseUpdateNotFoundErrorProperties`](../interfaces/OrderPurchaseUpdateNotFoundErrorProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/OrderPurchaseUpdateRequest.md b/release/fraudPreventionV2/src/docs/models/classes/OrderPurchaseUpdateRequest.md new file mode 100644 index 00000000..e57c5fdf --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/OrderPurchaseUpdateRequest.md @@ -0,0 +1,33 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > OrderPurchaseUpdateRequest + +# Class: OrderPurchaseUpdateRequest + +The `type` field value is used as a discriminator, with the following mapping: * `ORDER_UPDATE`: `OrderUpdate` * `CHARGEBACK_FEEDBACK`: `ChargebackFeedback` * `INSULT_FEEDBACK`: `InsultFeedback` * `REFUND_UPDATE`: `RefundUpdate` * `PAYMENT_UPDATE`: `PaymentUpdate` + +## Extended By + +- [`ChargebackFeedback`](ChargebackFeedback.md) +- [`InsultFeedback`](InsultFeedback.md) +- [`OrderUpdate`](OrderUpdate.md) +- [`PaymentUpdate`](PaymentUpdate.md) +- [`RefundUpdate`](RefundUpdate.md) + +## Constructors + +### new OrderPurchaseUpdateRequest(orderPurchaseUpdateRequest) + +> **new OrderPurchaseUpdateRequest**(`orderPurchaseUpdateRequest`): [`OrderPurchaseUpdateRequest`](OrderPurchaseUpdateRequest.md) + +#### Parameters + +▪ **orderPurchaseUpdateRequest**: [`OrderPurchaseUpdateRequestProperties`](../interfaces/OrderPurchaseUpdateRequestProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/OrderPurchaseUpdateResponse.md b/release/fraudPreventionV2/src/docs/models/classes/OrderPurchaseUpdateResponse.md new file mode 100644 index 00000000..ff417762 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/OrderPurchaseUpdateResponse.md @@ -0,0 +1,23 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > OrderPurchaseUpdateResponse + +# Class: OrderPurchaseUpdateResponse + +## Constructors + +### new OrderPurchaseUpdateResponse(orderPurchaseUpdateResponse) + +> **new OrderPurchaseUpdateResponse**(`orderPurchaseUpdateResponse`): [`OrderPurchaseUpdateResponse`](OrderPurchaseUpdateResponse.md) + +#### Parameters + +▪ **orderPurchaseUpdateResponse**: [`OrderPurchaseUpdateResponseProperties`](../interfaces/OrderPurchaseUpdateResponseProperties.md) + +#### Source + +models/OrderPurchaseUpdateResponse.ts:31 + +## Properties + +| Property | Type | Description | Source | +| :------ | :------ | :------ | :------ | +| `riskId?` | `string` | Unique identifier of transaction that was updated. | models/OrderPurchaseUpdateResponse.ts:29 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/OrderUpdate.md b/release/fraudPreventionV2/src/docs/models/classes/OrderUpdate.md new file mode 100644 index 00000000..27e16665 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/OrderUpdate.md @@ -0,0 +1,37 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > OrderUpdate + +# Class: OrderUpdate + +Order related data that should be updated. + +## Extends + +- [`OrderPurchaseUpdateRequest`](OrderPurchaseUpdateRequest.md) + +## Constructors + +### new OrderUpdate(orderUpdate) + +> **new OrderUpdate**(`orderUpdate`): [`OrderUpdate`](OrderUpdate.md) + +#### Parameters + +▪ **orderUpdate**: [`OrderUpdateProperties`](../interfaces/OrderUpdateProperties.md) + +#### Overrides + +[`OrderPurchaseUpdateRequest`](OrderPurchaseUpdateRequest.md).[`constructor`](OrderPurchaseUpdateRequest.md#constructors) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/PayPal.md b/release/fraudPreventionV2/src/docs/models/classes/PayPal.md new file mode 100644 index 00000000..412b57a7 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/PayPal.md @@ -0,0 +1,45 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > PayPal + +# Class: PayPal + +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` + +## Extends + +- [`Payment`](Payment.md) + +## Constructors + +### new PayPal(payPal) + +> **new PayPal**(`payPal`): [`PayPal`](PayPal.md) + +#### Parameters + +▪ **payPal**: [`PayPalProperties`](../interfaces/PayPalProperties.md) + +#### Overrides + +[`Payment`](Payment.md).[`constructor`](Payment.md#constructors) + +#### Source + +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` * `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` * `UATP` * `UATP_SUPPLY` * `AIR_PLUS` * `US_PASS_PLUS` \'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` | [`Payment`](Payment.md).`brand` | models/Payment.ts:48 | +| `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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/Payment.md b/release/fraudPreventionV2/src/docs/models/classes/Payment.md new file mode 100644 index 00000000..1d8166a4 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/Payment.md @@ -0,0 +1,42 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > Payment + +# Class: Payment + +The `method` field value is used as a discriminator, with the following mapping: * `CREDIT_CARD`: `CreditCard` * `PAYPAL`: `PayPal` * `POINTS`: `Points` * `GIFT_CARD`: `GiftCard` * `INTERNET_BANK_PAYMENT`: `InternetBankPayment` * `DIRECT_DEBIT`: `DirectDebit` + +## Extended By + +- [`CreditCard`](CreditCard.md) +- [`DirectDebit`](DirectDebit.md) +- [`GiftCard`](GiftCard.md) +- [`InternetBankPayment`](InternetBankPayment.md) +- [`PayPal`](PayPal.md) +- [`Points`](Points.md) + +## Constructors + +### new Payment(payment) + +> **new Payment**(`payment`): [`Payment`](Payment.md) + +#### Parameters + +▪ **payment**: [`PaymentProperties`](../interfaces/PaymentProperties.md) + +#### Source + +models/Payment.ts:87 + +## 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` * `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` * `UATP` * `UATP_SUPPLY` * `AIR_PLUS` * `US_PASS_PLUS` \'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` | models/Payment.ts:48 | +| `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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/PaymentBillingAddress.md b/release/fraudPreventionV2/src/docs/models/classes/PaymentBillingAddress.md new file mode 100644 index 00000000..0515488a --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/PaymentBillingAddress.md @@ -0,0 +1,29 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > PaymentBillingAddress + +# Class: PaymentBillingAddress + +## Constructors + +### new PaymentBillingAddress(paymentBillingAddress) + +> **new PaymentBillingAddress**(`paymentBillingAddress`): [`PaymentBillingAddress`](PaymentBillingAddress.md) + +#### Parameters + +▪ **paymentBillingAddress**: [`PaymentBillingAddressProperties`](../interfaces/PaymentBillingAddressProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/PaymentOperation.md b/release/fraudPreventionV2/src/docs/models/classes/PaymentOperation.md new file mode 100644 index 00000000..ee9e85f2 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/PaymentOperation.md @@ -0,0 +1,25 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > PaymentOperation + +# Class: PaymentOperation + +## Constructors + +### new PaymentOperation(paymentOperation) + +> **new PaymentOperation**(`paymentOperation`): [`PaymentOperation`](PaymentOperation.md) + +#### Parameters + +▪ **paymentOperation**: [`PaymentOperationProperties`](../interfaces/PaymentOperationProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/PaymentOutcome.md b/release/fraudPreventionV2/src/docs/models/classes/PaymentOutcome.md new file mode 100644 index 00000000..4e027cde --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/PaymentOutcome.md @@ -0,0 +1,25 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > PaymentOutcome + +# Class: PaymentOutcome + +## Constructors + +### new PaymentOutcome(paymentOutcome) + +> **new PaymentOutcome**(`paymentOutcome`): [`PaymentOutcome`](PaymentOutcome.md) + +#### Parameters + +▪ **paymentOutcome**: [`PaymentOutcomeProperties`](../interfaces/PaymentOutcomeProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/PaymentThreeDSCriteria.md b/release/fraudPreventionV2/src/docs/models/classes/PaymentThreeDSCriteria.md new file mode 100644 index 00000000..56938887 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/PaymentThreeDSCriteria.md @@ -0,0 +1,26 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > PaymentThreeDSCriteria + +# Class: PaymentThreeDSCriteria + +Payment ThreeDS criteria attributes. + +## Constructors + +### new PaymentThreeDSCriteria(paymentThreeDSCriteria) + +> **new PaymentThreeDSCriteria**(`paymentThreeDSCriteria`): [`PaymentThreeDSCriteria`](PaymentThreeDSCriteria.md) + +#### Parameters + +▪ **paymentThreeDSCriteria**: [`PaymentThreeDSCriteriaProperties`](../interfaces/PaymentThreeDSCriteriaProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/PaymentUpdate.md b/release/fraudPreventionV2/src/docs/models/classes/PaymentUpdate.md new file mode 100644 index 00000000..1dccf9fa --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/PaymentUpdate.md @@ -0,0 +1,35 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > PaymentUpdate + +# Class: PaymentUpdate + +Payment related data that should be updated. + +## Extends + +- [`OrderPurchaseUpdateRequest`](OrderPurchaseUpdateRequest.md) + +## Constructors + +### new PaymentUpdate(paymentUpdate) + +> **new PaymentUpdate**(`paymentUpdate`): [`PaymentUpdate`](PaymentUpdate.md) + +#### Parameters + +▪ **paymentUpdate**: [`PaymentUpdateProperties`](../interfaces/PaymentUpdateProperties.md) + +#### Overrides + +[`OrderPurchaseUpdateRequest`](OrderPurchaseUpdateRequest.md).[`constructor`](OrderPurchaseUpdateRequest.md#constructors) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/Points.md b/release/fraudPreventionV2/src/docs/models/classes/Points.md new file mode 100644 index 00000000..33bdb9b0 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/Points.md @@ -0,0 +1,43 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > Points + +# Class: Points + +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` + +## Extends + +- [`Payment`](Payment.md) + +## Constructors + +### new Points(points) + +> **new Points**(`points`): [`Points`](Points.md) + +#### Parameters + +▪ **points**: [`PointsProperties`](../interfaces/PointsProperties.md) + +#### Overrides + +[`Payment`](Payment.md).[`constructor`](Payment.md#constructors) + +#### Source + +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` * `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` * `UATP` * `UATP_SUPPLY` * `AIR_PLUS` * `US_PASS_PLUS` \'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` | [`Payment`](Payment.md).`brand` | models/Payment.ts:48 | +| `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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/Rail.md b/release/fraudPreventionV2/src/docs/models/classes/Rail.md new file mode 100644 index 00000000..7a6f9577 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/Rail.md @@ -0,0 +1,40 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > Rail + +# Class: Rail + +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` + +## Extends + +- [`TravelProduct`](TravelProduct.md) + +## Constructors + +### new Rail(rail) + +> **new Rail**(`rail`): [`Rail`](Rail.md) + +#### Parameters + +▪ **rail**: [`RailProperties`](../interfaces/RailProperties.md) + +#### Overrides + +[`TravelProduct`](TravelProduct.md).[`constructor`](TravelProduct.md#constructors) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/RailSegments.md b/release/fraudPreventionV2/src/docs/models/classes/RailSegments.md new file mode 100644 index 00000000..3d429ebd --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/RailSegments.md @@ -0,0 +1,28 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > RailSegments + +# Class: RailSegments + +## Constructors + +### new RailSegments(railSegments) + +> **new RailSegments**(`railSegments`): [`RailSegments`](RailSegments.md) + +#### Parameters + +▪ **railSegments**: [`RailSegmentsProperties`](../interfaces/RailSegmentsProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/RailSegmentsOperatingCompany.md b/release/fraudPreventionV2/src/docs/models/classes/RailSegmentsOperatingCompany.md new file mode 100644 index 00000000..2de093fa --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/RailSegmentsOperatingCompany.md @@ -0,0 +1,25 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > RailSegmentsOperatingCompany + +# Class: RailSegmentsOperatingCompany + +This attribute captures the name or identifier of the company responsible for operating the Rail product. It represents the specific operating entity, such as Amtrak, British Railways, or a bus company. + +## Constructors + +### new RailSegmentsOperatingCompany(railSegmentsOperatingCompany) + +> **new RailSegmentsOperatingCompany**(`railSegmentsOperatingCompany`): [`RailSegmentsOperatingCompany`](RailSegmentsOperatingCompany.md) + +#### Parameters + +▪ **railSegmentsOperatingCompany**: [`RailSegmentsOperatingCompanyProperties`](../interfaces/RailSegmentsOperatingCompanyProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/RailwayStationDetails.md b/release/fraudPreventionV2/src/docs/models/classes/RailwayStationDetails.md new file mode 100644 index 00000000..bea9f791 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/RailwayStationDetails.md @@ -0,0 +1,27 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > RailwayStationDetails + +# Class: RailwayStationDetails + +## Constructors + +### new RailwayStationDetails(railwayStationDetails) + +> **new RailwayStationDetails**(`railwayStationDetails`): [`RailwayStationDetails`](RailwayStationDetails.md) + +#### Parameters + +▪ **railwayStationDetails**: [`RailwayStationDetailsProperties`](../interfaces/RailwayStationDetailsProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/Refund.md b/release/fraudPreventionV2/src/docs/models/classes/Refund.md new file mode 100644 index 00000000..55fa4adc --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/Refund.md @@ -0,0 +1,27 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > Refund + +# Class: Refund + +Refund operation on the payment. A refund operation represents the intent to refund a previous charge. + +## Constructors + +### new Refund(refund) + +> **new Refund**(`refund`): [`Refund`](Refund.md) + +#### Parameters + +▪ **refund**: [`RefundProperties`](../interfaces/RefundProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/RefundUpdate.md b/release/fraudPreventionV2/src/docs/models/classes/RefundUpdate.md new file mode 100644 index 00000000..0490a8ee --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/RefundUpdate.md @@ -0,0 +1,34 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > RefundUpdate + +# Class: RefundUpdate + +Refund related data. Update should be sent when refund is issued or settled. Amounts should include all fees and taxes. + +## Extends + +- [`OrderPurchaseUpdateRequest`](OrderPurchaseUpdateRequest.md) + +## Constructors + +### new RefundUpdate(refundUpdate) + +> **new RefundUpdate**(`refundUpdate`): [`RefundUpdate`](RefundUpdate.md) + +#### Parameters + +▪ **refundUpdate**: [`RefundUpdateProperties`](../interfaces/RefundUpdateProperties.md) + +#### Overrides + +[`OrderPurchaseUpdateRequest`](OrderPurchaseUpdateRequest.md).[`constructor`](OrderPurchaseUpdateRequest.md#constructors) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/RemediationUpdate.md b/release/fraudPreventionV2/src/docs/models/classes/RemediationUpdate.md new file mode 100644 index 00000000..5f48d27e --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/RemediationUpdate.md @@ -0,0 +1,35 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > RemediationUpdate + +# Class: RemediationUpdate + +Information specific to remediation actions initiated by the Partner\'s system to a user as a result of a fraud recommendation. + +## Extends + +- [`AccountUpdateRequest`](AccountUpdateRequest.md) + +## Constructors + +### new RemediationUpdate(remediationUpdate) + +> **new RemediationUpdate**(`remediationUpdate`): [`RemediationUpdate`](RemediationUpdate.md) + +#### Parameters + +▪ **remediationUpdate**: [`RemediationUpdateProperties`](../interfaces/RemediationUpdateProperties.md) + +#### Overrides + +[`AccountUpdateRequest`](AccountUpdateRequest.md).[`constructor`](AccountUpdateRequest.md#constructors) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/RemediationUpdateAction.md b/release/fraudPreventionV2/src/docs/models/classes/RemediationUpdateAction.md new file mode 100644 index 00000000..881c1b59 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/RemediationUpdateAction.md @@ -0,0 +1,27 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > RemediationUpdateAction + +# Class: RemediationUpdateAction + +Information specific to the remediation action initiated by the Partner\'s system to a user. + +## Constructors + +### new RemediationUpdateAction(remediationUpdateAction) + +> **new RemediationUpdateAction**(`remediationUpdateAction`): [`RemediationUpdateAction`](RemediationUpdateAction.md) + +#### Parameters + +▪ **remediationUpdateAction**: [`RemediationUpdateActionProperties`](../interfaces/RemediationUpdateActionProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/RetryableOrderPurchaseScreenFailure.md b/release/fraudPreventionV2/src/docs/models/classes/RetryableOrderPurchaseScreenFailure.md new file mode 100644 index 00000000..29686cdc --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/RetryableOrderPurchaseScreenFailure.md @@ -0,0 +1,26 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > RetryableOrderPurchaseScreenFailure + +# 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 `` .\" + +## Constructors + +### new RetryableOrderPurchaseScreenFailure(retryableOrderPurchaseScreenFailure) + +> **new RetryableOrderPurchaseScreenFailure**(`retryableOrderPurchaseScreenFailure`): [`RetryableOrderPurchaseScreenFailure`](RetryableOrderPurchaseScreenFailure.md) + +#### Parameters + +▪ **retryableOrderPurchaseScreenFailure**: [`RetryableOrderPurchaseScreenFailureProperties`](../interfaces/RetryableOrderPurchaseScreenFailureProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/RetryableOrderPurchaseUpdateFailure.md b/release/fraudPreventionV2/src/docs/models/classes/RetryableOrderPurchaseUpdateFailure.md new file mode 100644 index 00000000..2dc45ef3 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/RetryableOrderPurchaseUpdateFailure.md @@ -0,0 +1,26 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > RetryableOrderPurchaseUpdateFailure + +# 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 `` .\" + +## Constructors + +### new RetryableOrderPurchaseUpdateFailure(retryableOrderPurchaseUpdateFailure) + +> **new RetryableOrderPurchaseUpdateFailure**(`retryableOrderPurchaseUpdateFailure`): [`RetryableOrderPurchaseUpdateFailure`](RetryableOrderPurchaseUpdateFailure.md) + +#### Parameters + +▪ **retryableOrderPurchaseUpdateFailure**: [`RetryableOrderPurchaseUpdateFailureProperties`](../interfaces/RetryableOrderPurchaseUpdateFailureProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/ServiceUnavailableError.md b/release/fraudPreventionV2/src/docs/models/classes/ServiceUnavailableError.md new file mode 100644 index 00000000..95a0ec05 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/ServiceUnavailableError.md @@ -0,0 +1,26 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > ServiceUnavailableError + +# 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 `` .\" + +## Constructors + +### new ServiceUnavailableError(serviceUnavailableError) + +> **new ServiceUnavailableError**(`serviceUnavailableError`): [`ServiceUnavailableError`](ServiceUnavailableError.md) + +#### Parameters + +▪ **serviceUnavailableError**: [`ServiceUnavailableErrorProperties`](../interfaces/ServiceUnavailableErrorProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/SettledRefundUpdate.md b/release/fraudPreventionV2/src/docs/models/classes/SettledRefundUpdate.md new file mode 100644 index 00000000..1d1143e6 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/SettledRefundUpdate.md @@ -0,0 +1,36 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > SettledRefundUpdate + +# Class: SettledRefundUpdate + +Data related to the settled refund that should be updated. + +## Extends + +- [`RefundUpdate`](RefundUpdate.md) + +## Constructors + +### new SettledRefundUpdate(settledRefundUpdate) + +> **new SettledRefundUpdate**(`settledRefundUpdate`): [`SettledRefundUpdate`](SettledRefundUpdate.md) + +#### Parameters + +▪ **settledRefundUpdate**: [`SettledRefundUpdateProperties`](../interfaces/SettledRefundUpdateProperties.md) + +#### Overrides + +[`RefundUpdate`](RefundUpdate.md).[`constructor`](RefundUpdate.md#constructors) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/SettledRefundUpdateDetails.md b/release/fraudPreventionV2/src/docs/models/classes/SettledRefundUpdateDetails.md new file mode 100644 index 00000000..ec21f857 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/SettledRefundUpdateDetails.md @@ -0,0 +1,29 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > SettledRefundUpdateDetails + +# Class: SettledRefundUpdateDetails + +Data that describes settled refund that should be updated. + +## Constructors + +### new SettledRefundUpdateDetails(settledRefundUpdateDetails) + +> **new SettledRefundUpdateDetails**(`settledRefundUpdateDetails`): [`SettledRefundUpdateDetails`](SettledRefundUpdateDetails.md) + +#### Parameters + +▪ **settledRefundUpdateDetails**: [`SettledRefundUpdateDetailsProperties`](../interfaces/SettledRefundUpdateDetailsProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/SiteInfo.md b/release/fraudPreventionV2/src/docs/models/classes/SiteInfo.md new file mode 100644 index 00000000..ef8b3524 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/SiteInfo.md @@ -0,0 +1,24 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > SiteInfo + +# Class: SiteInfo + +## Constructors + +### new SiteInfo(siteInfo) + +> **new SiteInfo**(`siteInfo`): [`SiteInfo`](SiteInfo.md) + +#### Parameters + +▪ **siteInfo**: [`SiteInfoProperties`](../interfaces/SiteInfoProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/Telephone.md b/release/fraudPreventionV2/src/docs/models/classes/Telephone.md new file mode 100644 index 00000000..c3c503c5 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/Telephone.md @@ -0,0 +1,33 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > Telephone + +# Class: Telephone + +Group of attributes intended to hold information about phone number associated with the transaction. A user can have one to many phone numbers (home, work, mobile, etc.). + +## Constructors + +### new Telephone(telephone) + +> **new Telephone**(`telephone`): [`Telephone`](Telephone.md) + +#### Parameters + +▪ **telephone**: [`TelephoneProperties`](../interfaces/TelephoneProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/TooManyRequestsError.md b/release/fraudPreventionV2/src/docs/models/classes/TooManyRequestsError.md new file mode 100644 index 00000000..82e52240 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/TooManyRequestsError.md @@ -0,0 +1,26 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > TooManyRequestsError + +# 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. + +## Constructors + +### new TooManyRequestsError(tooManyRequestsError) + +> **new TooManyRequestsError**(`tooManyRequestsError`): [`TooManyRequestsError`](TooManyRequestsError.md) + +#### Parameters + +▪ **tooManyRequestsError**: [`TooManyRequestsErrorProperties`](../interfaces/TooManyRequestsErrorProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/TransactionDetails.md b/release/fraudPreventionV2/src/docs/models/classes/TransactionDetails.md new file mode 100644 index 00000000..cc7ee723 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/TransactionDetails.md @@ -0,0 +1,28 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > TransactionDetails + +# Class: TransactionDetails + +## Constructors + +### new TransactionDetails(transactionDetails) + +> **new TransactionDetails**(`transactionDetails`): [`TransactionDetails`](TransactionDetails.md) + +#### Parameters + +▪ **transactionDetails**: [`TransactionDetailsProperties`](../interfaces/TransactionDetailsProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/TravelProduct.md b/release/fraudPreventionV2/src/docs/models/classes/TravelProduct.md new file mode 100644 index 00000000..98aa15fb --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/TravelProduct.md @@ -0,0 +1,38 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > TravelProduct + +# Class: TravelProduct + +The `type` field value is used as a discriminator, with the following mapping: * `CRUISE`: `Cruise` * `AIR`: `Air` * `CAR`: `Car` * `INSURANCE`: `Insurance` * `HOTEL`: `Hotel` * `RAIL`: `Rail` + +## Extended By + +- [`Air`](Air.md) +- [`Car`](Car.md) +- [`Cruise`](Cruise.md) +- [`Hotel`](Hotel.md) +- [`Insurance`](Insurance.md) +- [`Rail`](Rail.md) + +## Constructors + +### new TravelProduct(travelProduct) + +> **new TravelProduct**(`travelProduct`): [`TravelProduct`](TravelProduct.md) + +#### Parameters + +▪ **travelProduct**: [`TravelProductProperties`](../interfaces/TravelProductProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/Traveler.md b/release/fraudPreventionV2/src/docs/models/classes/Traveler.md new file mode 100644 index 00000000..9991a17a --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/Traveler.md @@ -0,0 +1,30 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > Traveler + +# Class: Traveler + +## Constructors + +### new Traveler(traveler) + +> **new Traveler**(`traveler`): [`Traveler`](Traveler.md) + +#### Parameters + +▪ **traveler**: [`TravelerProperties`](../interfaces/TravelerProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/UnauthorizedError.md b/release/fraudPreventionV2/src/docs/models/classes/UnauthorizedError.md new file mode 100644 index 00000000..425acfa1 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/UnauthorizedError.md @@ -0,0 +1,26 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > UnauthorizedError + +# Class: UnauthorizedError + +Indicates that the token sent in the \'Authorization\' header is either invalid or missing. Please check the value in the token field along with the token expiration time before retrying. + +## Constructors + +### new UnauthorizedError(unauthorizedError) + +> **new UnauthorizedError**(`unauthorizedError`): [`UnauthorizedError`](UnauthorizedError.md) + +#### Parameters + +▪ **unauthorizedError**: [`UnauthorizedErrorProperties`](../interfaces/UnauthorizedErrorProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/classes/Verify.md b/release/fraudPreventionV2/src/docs/models/classes/Verify.md new file mode 100644 index 00000000..9ed987e1 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/classes/Verify.md @@ -0,0 +1,28 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > Verify + +# Class: Verify + +A verify operation represents the intent to verify the payment associated with this transaction. + +## Constructors + +### new Verify(verify) + +> **new Verify**(`verify`): [`Verify`](Verify.md) + +#### Parameters + +▪ **verify**: [`VerifyProperties`](../interfaces/VerifyProperties.md) + +#### Source + +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 | diff --git a/release/fraudPreventionV2/src/docs/models/core/classes/AxiosClientConfigurations.md b/release/fraudPreventionV2/src/docs/models/core/classes/AxiosClientConfigurations.md new file mode 100644 index 00000000..2c4ae580 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/core/classes/AxiosClientConfigurations.md @@ -0,0 +1,26 @@ +[@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` + +#### 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/class.Client.md b/release/fraudPreventionV2/src/docs/models/core/classes/Client.md similarity index 54% rename from release/fraudPreventionV2/docs/models/core/classes/class.Client.md rename to release/fraudPreventionV2/src/docs/models/core/classes/Client.md index d5f963b6..b9ddda81 100644 --- a/release/fraudPreventionV2/docs/models/core/classes/class.Client.md +++ b/release/fraudPreventionV2/src/docs/models/core/classes/Client.md @@ -1,7 +1,7 @@ [@expediagroup/fraudpreventionv2-sdk](../../../index.md) > [models](../../index.md) > [core](../index.md) > Client -# Class: Client +# Class: `abstract` Client ## Extended By -- [`FraudPreventionV2Client`](../../../client/classes/class.FraudPreventionV2Client.md) +- [`FraudPreventionV2Client`](../../../client/classes/FraudPreventionV2Client.md) diff --git a/release/fraudPreventionV2/src/docs/models/core/index.md b/release/fraudPreventionV2/src/docs/models/core/index.md new file mode 100644 index 00000000..a056a1fd --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/core/index.md @@ -0,0 +1,14 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > core + +# Module: core + +## Index + +### Classes + +- [AxiosClientConfigurations](classes/AxiosClientConfigurations.md) +- [Client](classes/Client.md) + +### Interfaces + +- [ClientConfigurations](interfaces/ClientConfigurations.md) diff --git a/release/fraudPreventionV2/src/docs/models/core/interfaces/ClientConfigurations.md b/release/fraudPreventionV2/src/docs/models/core/interfaces/ClientConfigurations.md new file mode 100644 index 00000000..f324c65d --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/core/interfaces/ClientConfigurations.md @@ -0,0 +1,13 @@ +[@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/src/docs/models/index.md b/release/fraudPreventionV2/src/docs/models/index.md new file mode 100644 index 00000000..ab2f80f0 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/index.md @@ -0,0 +1,266 @@ +[@expediagroup/fraudpreventionv2-sdk](../index.md) > models + +# Module: models + +## Index + +### Modules + +- [core](core/index.md) + +### Classes + +- [AccountScreenRequest](classes/AccountScreenRequest.md) +- [AccountScreenResponse](classes/AccountScreenResponse.md) +- [AccountTakeoverBadRequestError](classes/AccountTakeoverBadRequestError.md) +- [AccountTakeoverBadRequestErrorAllOfCauses](classes/AccountTakeoverBadRequestErrorAllOfCauses.md) +- [AccountTakeoverCustomerAccount](classes/AccountTakeoverCustomerAccount.md) +- [AccountTakeoverDeviceDetails](classes/AccountTakeoverDeviceDetails.md) +- [AccountTakeoverError](classes/AccountTakeoverError.md) +- [AccountTakeoverName](classes/AccountTakeoverName.md) +- [AccountTakeoverSiteInfo](classes/AccountTakeoverSiteInfo.md) +- [AccountTakeoverTransactionDetails](classes/AccountTakeoverTransactionDetails.md) +- [AccountTakeoverUnauthorizedError](classes/AccountTakeoverUnauthorizedError.md) +- [AccountTransaction](classes/AccountTransaction.md) +- [AccountUpdateNotFoundError](classes/AccountUpdateNotFoundError.md) +- [AccountUpdateRequest](classes/AccountUpdateRequest.md) +- [AccountUpdateResponse](classes/AccountUpdateResponse.md) +- [Address](classes/Address.md) +- [Air](classes/Air.md) +- [AirSegment](classes/AirSegment.md) +- [Amount](classes/Amount.md) +- [Authorize](classes/Authorize.md) +- [AuthorizeReversal](classes/AuthorizeReversal.md) +- [BadGatewayError](classes/BadGatewayError.md) +- [BadRequestError](classes/BadRequestError.md) +- [BadRequestErrorAllOfCauses](classes/BadRequestErrorAllOfCauses.md) +- [CancellationReason](classes/CancellationReason.md) +- [Capture](classes/Capture.md) +- [Car](classes/Car.md) +- [ChallengeDetail](classes/ChallengeDetail.md) +- [ChargebackDetail](classes/ChargebackDetail.md) +- [ChargebackFeedback](classes/ChargebackFeedback.md) +- [CreditCard](classes/CreditCard.md) +- [Cruise](classes/Cruise.md) +- [CurrentUserSession](classes/CurrentUserSession.md) +- [CustomerAccount](classes/CustomerAccount.md) +- [CustomerAccountAddress](classes/CustomerAccountAddress.md) +- [DeviceDetails](classes/DeviceDetails.md) +- [DirectDebit](classes/DirectDebit.md) +- [Email](classes/Email.md) +- [ForbiddenError](classes/ForbiddenError.md) +- [GatewayTimeoutError](classes/GatewayTimeoutError.md) +- [GiftCard](classes/GiftCard.md) +- [Hotel](classes/Hotel.md) +- [HotelAddress](classes/HotelAddress.md) +- [InsultDetail](classes/InsultDetail.md) +- [InsultFeedback](classes/InsultFeedback.md) +- [Insurance](classes/Insurance.md) +- [InternalServerError](classes/InternalServerError.md) +- [InternetBankPayment](classes/InternetBankPayment.md) +- [IssuedRefundUpdate](classes/IssuedRefundUpdate.md) +- [IssuedRefundUpdateDetails](classes/IssuedRefundUpdateDetails.md) +- [LoginTransactionDetails](classes/LoginTransactionDetails.md) +- [ModelError](classes/ModelError.md) +- [MultiFactorAuthenticationAttempt](classes/MultiFactorAuthenticationAttempt.md) +- [MultiFactorAuthenticationUpdate](classes/MultiFactorAuthenticationUpdate.md) +- [Name](classes/Name.md) +- [NotFoundError](classes/NotFoundError.md) +- [Operations](classes/Operations.md) +- [OrderPurchaseScreenRequest](classes/OrderPurchaseScreenRequest.md) +- [OrderPurchaseScreenResponse](classes/OrderPurchaseScreenResponse.md) +- [OrderPurchaseTransaction](classes/OrderPurchaseTransaction.md) +- [OrderPurchaseUpdateNotFoundError](classes/OrderPurchaseUpdateNotFoundError.md) +- [OrderPurchaseUpdateRequest](classes/OrderPurchaseUpdateRequest.md) +- [OrderPurchaseUpdateResponse](classes/OrderPurchaseUpdateResponse.md) +- [OrderUpdate](classes/OrderUpdate.md) +- [PayPal](classes/PayPal.md) +- [Payment](classes/Payment.md) +- [PaymentBillingAddress](classes/PaymentBillingAddress.md) +- [PaymentOperation](classes/PaymentOperation.md) +- [PaymentOutcome](classes/PaymentOutcome.md) +- [PaymentThreeDSCriteria](classes/PaymentThreeDSCriteria.md) +- [PaymentUpdate](classes/PaymentUpdate.md) +- [Points](classes/Points.md) +- [Rail](classes/Rail.md) +- [RailSegments](classes/RailSegments.md) +- [RailSegmentsOperatingCompany](classes/RailSegmentsOperatingCompany.md) +- [RailwayStationDetails](classes/RailwayStationDetails.md) +- [Refund](classes/Refund.md) +- [RefundUpdate](classes/RefundUpdate.md) +- [RemediationUpdate](classes/RemediationUpdate.md) +- [RemediationUpdateAction](classes/RemediationUpdateAction.md) +- [RetryableOrderPurchaseScreenFailure](classes/RetryableOrderPurchaseScreenFailure.md) +- [RetryableOrderPurchaseUpdateFailure](classes/RetryableOrderPurchaseUpdateFailure.md) +- [ServiceUnavailableError](classes/ServiceUnavailableError.md) +- [SettledRefundUpdate](classes/SettledRefundUpdate.md) +- [SettledRefundUpdateDetails](classes/SettledRefundUpdateDetails.md) +- [SiteInfo](classes/SiteInfo.md) +- [Telephone](classes/Telephone.md) +- [TooManyRequestsError](classes/TooManyRequestsError.md) +- [TransactionDetails](classes/TransactionDetails.md) +- [TravelProduct](classes/TravelProduct.md) +- [Traveler](classes/Traveler.md) +- [UnauthorizedError](classes/UnauthorizedError.md) +- [Verify](classes/Verify.md) + +### Interfaces + +- [AccountScreenRequestProperties](interfaces/AccountScreenRequestProperties.md) +- [AccountScreenResponseProperties](interfaces/AccountScreenResponseProperties.md) +- [AccountTakeoverBadRequestErrorAllOfCausesProperties](interfaces/AccountTakeoverBadRequestErrorAllOfCausesProperties.md) +- [AccountTakeoverBadRequestErrorProperties](interfaces/AccountTakeoverBadRequestErrorProperties.md) +- [AccountTakeoverCustomerAccountProperties](interfaces/AccountTakeoverCustomerAccountProperties.md) +- [AccountTakeoverDeviceDetailsProperties](interfaces/AccountTakeoverDeviceDetailsProperties.md) +- [AccountTakeoverErrorProperties](interfaces/AccountTakeoverErrorProperties.md) +- [AccountTakeoverNameProperties](interfaces/AccountTakeoverNameProperties.md) +- [AccountTakeoverSiteInfoProperties](interfaces/AccountTakeoverSiteInfoProperties.md) +- [AccountTakeoverTransactionDetailsProperties](interfaces/AccountTakeoverTransactionDetailsProperties.md) +- [AccountTakeoverUnauthorizedErrorProperties](interfaces/AccountTakeoverUnauthorizedErrorProperties.md) +- [AccountTransactionProperties](interfaces/AccountTransactionProperties.md) +- [AccountUpdateNotFoundErrorProperties](interfaces/AccountUpdateNotFoundErrorProperties.md) +- [AccountUpdateRequestProperties](interfaces/AccountUpdateRequestProperties.md) +- [AccountUpdateResponseProperties](interfaces/AccountUpdateResponseProperties.md) +- [AddressProperties](interfaces/AddressProperties.md) +- [AirProperties](interfaces/AirProperties.md) +- [AirSegmentProperties](interfaces/AirSegmentProperties.md) +- [AmountProperties](interfaces/AmountProperties.md) +- [AuthorizeProperties](interfaces/AuthorizeProperties.md) +- [AuthorizeReversalProperties](interfaces/AuthorizeReversalProperties.md) +- [BadGatewayErrorProperties](interfaces/BadGatewayErrorProperties.md) +- [BadRequestErrorAllOfCausesProperties](interfaces/BadRequestErrorAllOfCausesProperties.md) +- [BadRequestErrorProperties](interfaces/BadRequestErrorProperties.md) +- [CancellationReasonProperties](interfaces/CancellationReasonProperties.md) +- [CaptureProperties](interfaces/CaptureProperties.md) +- [CarProperties](interfaces/CarProperties.md) +- [ChallengeDetailProperties](interfaces/ChallengeDetailProperties.md) +- [ChargebackDetailProperties](interfaces/ChargebackDetailProperties.md) +- [ChargebackFeedbackProperties](interfaces/ChargebackFeedbackProperties.md) +- [CreditCardProperties](interfaces/CreditCardProperties.md) +- [CruiseProperties](interfaces/CruiseProperties.md) +- [CurrentUserSessionProperties](interfaces/CurrentUserSessionProperties.md) +- [CustomerAccountAddressProperties](interfaces/CustomerAccountAddressProperties.md) +- [CustomerAccountProperties](interfaces/CustomerAccountProperties.md) +- [DeviceDetailsProperties](interfaces/DeviceDetailsProperties.md) +- [DirectDebitProperties](interfaces/DirectDebitProperties.md) +- [EmailProperties](interfaces/EmailProperties.md) +- [ForbiddenErrorProperties](interfaces/ForbiddenErrorProperties.md) +- [GatewayTimeoutErrorProperties](interfaces/GatewayTimeoutErrorProperties.md) +- [GiftCardProperties](interfaces/GiftCardProperties.md) +- [HotelAddressProperties](interfaces/HotelAddressProperties.md) +- [HotelProperties](interfaces/HotelProperties.md) +- [InsultDetailProperties](interfaces/InsultDetailProperties.md) +- [InsultFeedbackProperties](interfaces/InsultFeedbackProperties.md) +- [InsuranceProperties](interfaces/InsuranceProperties.md) +- [InternalServerErrorProperties](interfaces/InternalServerErrorProperties.md) +- [InternetBankPaymentProperties](interfaces/InternetBankPaymentProperties.md) +- [IssuedRefundUpdateDetailsProperties](interfaces/IssuedRefundUpdateDetailsProperties.md) +- [IssuedRefundUpdateProperties](interfaces/IssuedRefundUpdateProperties.md) +- [LoginTransactionDetailsProperties](interfaces/LoginTransactionDetailsProperties.md) +- [ModelErrorProperties](interfaces/ModelErrorProperties.md) +- [MultiFactorAuthenticationAttemptProperties](interfaces/MultiFactorAuthenticationAttemptProperties.md) +- [MultiFactorAuthenticationUpdateProperties](interfaces/MultiFactorAuthenticationUpdateProperties.md) +- [NameProperties](interfaces/NameProperties.md) +- [NotFoundErrorProperties](interfaces/NotFoundErrorProperties.md) +- [OperationsProperties](interfaces/OperationsProperties.md) +- [OrderPurchaseScreenRequestProperties](interfaces/OrderPurchaseScreenRequestProperties.md) +- [OrderPurchaseScreenResponseProperties](interfaces/OrderPurchaseScreenResponseProperties.md) +- [OrderPurchaseTransactionProperties](interfaces/OrderPurchaseTransactionProperties.md) +- [OrderPurchaseUpdateNotFoundErrorProperties](interfaces/OrderPurchaseUpdateNotFoundErrorProperties.md) +- [OrderPurchaseUpdateRequestProperties](interfaces/OrderPurchaseUpdateRequestProperties.md) +- [OrderPurchaseUpdateResponseProperties](interfaces/OrderPurchaseUpdateResponseProperties.md) +- [OrderUpdateProperties](interfaces/OrderUpdateProperties.md) +- [PayPalProperties](interfaces/PayPalProperties.md) +- [PaymentBillingAddressProperties](interfaces/PaymentBillingAddressProperties.md) +- [PaymentOperationProperties](interfaces/PaymentOperationProperties.md) +- [PaymentOutcomeProperties](interfaces/PaymentOutcomeProperties.md) +- [PaymentProperties](interfaces/PaymentProperties.md) +- [PaymentThreeDSCriteriaProperties](interfaces/PaymentThreeDSCriteriaProperties.md) +- [PaymentUpdateProperties](interfaces/PaymentUpdateProperties.md) +- [PointsProperties](interfaces/PointsProperties.md) +- [RailProperties](interfaces/RailProperties.md) +- [RailSegmentsOperatingCompanyProperties](interfaces/RailSegmentsOperatingCompanyProperties.md) +- [RailSegmentsProperties](interfaces/RailSegmentsProperties.md) +- [RailwayStationDetailsProperties](interfaces/RailwayStationDetailsProperties.md) +- [RefundProperties](interfaces/RefundProperties.md) +- [RefundUpdateProperties](interfaces/RefundUpdateProperties.md) +- [RemediationUpdateActionProperties](interfaces/RemediationUpdateActionProperties.md) +- [RemediationUpdateProperties](interfaces/RemediationUpdateProperties.md) +- [RetryableOrderPurchaseScreenFailureProperties](interfaces/RetryableOrderPurchaseScreenFailureProperties.md) +- [RetryableOrderPurchaseUpdateFailureProperties](interfaces/RetryableOrderPurchaseUpdateFailureProperties.md) +- [ServiceUnavailableErrorProperties](interfaces/ServiceUnavailableErrorProperties.md) +- [SettledRefundUpdateDetailsProperties](interfaces/SettledRefundUpdateDetailsProperties.md) +- [SettledRefundUpdateProperties](interfaces/SettledRefundUpdateProperties.md) +- [SiteInfoProperties](interfaces/SiteInfoProperties.md) +- [TelephoneProperties](interfaces/TelephoneProperties.md) +- [TooManyRequestsErrorProperties](interfaces/TooManyRequestsErrorProperties.md) +- [TransactionDetailsProperties](interfaces/TransactionDetailsProperties.md) +- [TravelProductProperties](interfaces/TravelProductProperties.md) +- [TravelerProperties](interfaces/TravelerProperties.md) +- [UnauthorizedErrorProperties](interfaces/UnauthorizedErrorProperties.md) +- [VerifyProperties](interfaces/VerifyProperties.md) + +### Type Aliases + +- [AccountTakeoverBadRequestErrorAllOfCausesCodeEnum](type-aliases/AccountTakeoverBadRequestErrorAllOfCausesCodeEnum.md) +- [AccountTakeoverBadRequestErrorCodeEnum](type-aliases/AccountTakeoverBadRequestErrorCodeEnum.md) +- [AccountTakeoverCustomerAccountAccountRoleEnum](type-aliases/AccountTakeoverCustomerAccountAccountRoleEnum.md) +- [AccountTakeoverCustomerAccountAccountTypeEnum](type-aliases/AccountTakeoverCustomerAccountAccountTypeEnum.md) +- [AccountTakeoverDeviceDetailsTypeEnum](type-aliases/AccountTakeoverDeviceDetailsTypeEnum.md) +- [AccountTakeoverErrorCodeEnum](type-aliases/AccountTakeoverErrorCodeEnum.md) +- [AccountTakeoverFraudDecision](type-aliases/AccountTakeoverFraudDecision.md) +- [AccountTakeoverSiteInfoPlacementNameEnum](type-aliases/AccountTakeoverSiteInfoPlacementNameEnum.md) +- [AccountTakeoverTransactionDetailsTypeEnum](type-aliases/AccountTakeoverTransactionDetailsTypeEnum.md) +- [AccountTakeoverUnauthorizedErrorCodeEnum](type-aliases/AccountTakeoverUnauthorizedErrorCodeEnum.md) +- [AccountUpdateNotFoundErrorCodeEnum](type-aliases/AccountUpdateNotFoundErrorCodeEnum.md) +- [AccountUpdateRequestTypeEnum](type-aliases/AccountUpdateRequestTypeEnum.md) +- [AddressAddressTypeEnum](type-aliases/AddressAddressTypeEnum.md) +- [AirFlightTypeEnum](type-aliases/AirFlightTypeEnum.md) +- [BadGatewayErrorCodeEnum](type-aliases/BadGatewayErrorCodeEnum.md) +- [BadRequestErrorAllOfCausesCodeEnum](type-aliases/BadRequestErrorAllOfCausesCodeEnum.md) +- [BadRequestErrorCodeEnum](type-aliases/BadRequestErrorCodeEnum.md) +- [ChallengeDetailStatusEnum](type-aliases/ChallengeDetailStatusEnum.md) +- [ChallengeDetailTypeEnum](type-aliases/ChallengeDetailTypeEnum.md) +- [ChargebackDetailChargebackReasonEnum](type-aliases/ChargebackDetailChargebackReasonEnum.md) +- [ChargebackDetailChargebackStatusEnum](type-aliases/ChargebackDetailChargebackStatusEnum.md) +- [CreditCardCardTypeEnum](type-aliases/CreditCardCardTypeEnum.md) +- [CustomerAccountAccountTypeEnum](type-aliases/CustomerAccountAccountTypeEnum.md) +- [CustomerAccountAddressAddressTypeEnum](type-aliases/CustomerAccountAddressAddressTypeEnum.md) +- [ForbiddenErrorCodeEnum](type-aliases/ForbiddenErrorCodeEnum.md) +- [FraudDecision](type-aliases/FraudDecision.md) +- [GatewayTimeoutErrorCodeEnum](type-aliases/GatewayTimeoutErrorCodeEnum.md) +- [HotelAddressAddressTypeEnum](type-aliases/HotelAddressAddressTypeEnum.md) +- [InternalServerErrorCodeEnum](type-aliases/InternalServerErrorCodeEnum.md) +- [LoginTransactionDetailsAuthenticationSubTypeEnum](type-aliases/LoginTransactionDetailsAuthenticationSubTypeEnum.md) +- [LoginTransactionDetailsAuthenticationTypeEnum](type-aliases/LoginTransactionDetailsAuthenticationTypeEnum.md) +- [LoginTransactionDetailsFailedLoginReasonEnum](type-aliases/LoginTransactionDetailsFailedLoginReasonEnum.md) +- [ModelErrorCodeEnum](type-aliases/ModelErrorCodeEnum.md) +- [MultiFactorAuthenticationAttemptDeliveryMethodEnum](type-aliases/MultiFactorAuthenticationAttemptDeliveryMethodEnum.md) +- [MultiFactorAuthenticationAttemptStatusEnum](type-aliases/MultiFactorAuthenticationAttemptStatusEnum.md) +- [NotFoundErrorCodeEnum](type-aliases/NotFoundErrorCodeEnum.md) +- [OrderPurchaseUpdateNotFoundErrorCodeEnum](type-aliases/OrderPurchaseUpdateNotFoundErrorCodeEnum.md) +- [PaymentBillingAddressAddressTypeEnum](type-aliases/PaymentBillingAddressAddressTypeEnum.md) +- [PaymentBrandEnum](type-aliases/PaymentBrandEnum.md) +- [PaymentMethod](type-aliases/PaymentMethod.md) +- [PaymentReason](type-aliases/PaymentReason.md) +- [PaymentStatus](type-aliases/PaymentStatus.md) +- [RailRouteTypeEnum](type-aliases/RailRouteTypeEnum.md) +- [RailSegmentsTransportationMethodEnum](type-aliases/RailSegmentsTransportationMethodEnum.md) +- [RailwayStationDetailsTypeEnum](type-aliases/RailwayStationDetailsTypeEnum.md) +- [RefundUpdateRefundStatusEnum](type-aliases/RefundUpdateRefundStatusEnum.md) +- [RemediationUpdateActionActionNameEnum](type-aliases/RemediationUpdateActionActionNameEnum.md) +- [RemediationUpdateActionStatusEnum](type-aliases/RemediationUpdateActionStatusEnum.md) +- [RetryableOrderPurchaseScreenFailureCodeEnum](type-aliases/RetryableOrderPurchaseScreenFailureCodeEnum.md) +- [RetryableOrderPurchaseUpdateFailureCodeEnum](type-aliases/RetryableOrderPurchaseUpdateFailureCodeEnum.md) +- [ServiceUnavailableErrorCodeEnum](type-aliases/ServiceUnavailableErrorCodeEnum.md) +- [Status](type-aliases/Status.md) +- [TelephonePlatformType](type-aliases/TelephonePlatformType.md) +- [TelephoneType](type-aliases/TelephoneType.md) +- [TooManyRequestsErrorCodeEnum](type-aliases/TooManyRequestsErrorCodeEnum.md) +- [TransactionDetailsCurrentOrderStatusEnum](type-aliases/TransactionDetailsCurrentOrderStatusEnum.md) +- [TransactionDetailsOrderTypeEnum](type-aliases/TransactionDetailsOrderTypeEnum.md) +- [TravelProductInventorySourceEnum](type-aliases/TravelProductInventorySourceEnum.md) +- [TravelProductType](type-aliases/TravelProductType.md) +- [UnauthorizedErrorCodeEnum](type-aliases/UnauthorizedErrorCodeEnum.md) +- [UpdateType](type-aliases/UpdateType.md) +- [VerificationType](type-aliases/VerificationType.md) diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/AccountScreenRequestProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/AccountScreenRequestProperties.md new file mode 100644 index 00000000..c2cdb5e0 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/AccountScreenRequestProperties.md @@ -0,0 +1,9 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountScreenRequestProperties + +# Interface: AccountScreenRequestProperties + +## Properties + +| Property | Type | Description | Source | +| :------ | :------ | :------ | :------ | +| `transaction` | [`AccountTransaction`](../classes/AccountTransaction.md) | - | models/AccountScreenRequest.ts:42 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/AccountScreenResponseProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/AccountScreenResponseProperties.md new file mode 100644 index 00000000..aab12c3f --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/AccountScreenResponseProperties.md @@ -0,0 +1,10 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountScreenResponseProperties + +# Interface: AccountScreenResponseProperties + +## Properties + +| Property | Type | Description | Source | +| :------ | :------ | :------ | :------ | +| `decision?` | [`AccountTakeoverFraudDecision`](../type-aliases/AccountTakeoverFraudDecision.md) | - | models/AccountScreenResponse.ts:45 | +| `riskId?` | `string` | - | models/AccountScreenResponse.ts:44 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/AccountTakeoverBadRequestErrorAllOfCausesProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/AccountTakeoverBadRequestErrorAllOfCausesProperties.md new file mode 100644 index 00000000..b4d34e91 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/AccountTakeoverBadRequestErrorAllOfCausesProperties.md @@ -0,0 +1,11 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountTakeoverBadRequestErrorAllOfCausesProperties + +# Interface: AccountTakeoverBadRequestErrorAllOfCausesProperties + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/AccountTakeoverBadRequestErrorProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/AccountTakeoverBadRequestErrorProperties.md new file mode 100644 index 00000000..6ab42053 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/AccountTakeoverBadRequestErrorProperties.md @@ -0,0 +1,11 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountTakeoverBadRequestErrorProperties + +# Interface: AccountTakeoverBadRequestErrorProperties + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/AccountTakeoverCustomerAccountProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/AccountTakeoverCustomerAccountProperties.md new file mode 100644 index 00000000..b97cd7b0 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/AccountTakeoverCustomerAccountProperties.md @@ -0,0 +1,19 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountTakeoverCustomerAccountProperties + +# Interface: AccountTakeoverCustomerAccountProperties + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/AccountTakeoverDeviceDetailsProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/AccountTakeoverDeviceDetailsProperties.md new file mode 100644 index 00000000..fb9af749 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/AccountTakeoverDeviceDetailsProperties.md @@ -0,0 +1,13 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountTakeoverDeviceDetailsProperties + +# Interface: AccountTakeoverDeviceDetailsProperties + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/AccountTakeoverErrorProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/AccountTakeoverErrorProperties.md new file mode 100644 index 00000000..797c8ce8 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/AccountTakeoverErrorProperties.md @@ -0,0 +1,10 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountTakeoverErrorProperties + +# Interface: AccountTakeoverErrorProperties + +## Properties + +| Property | Type | Description | Source | +| :------ | :------ | :------ | :------ | +| `code` | [`AccountTakeoverErrorCodeEnum`](../type-aliases/AccountTakeoverErrorCodeEnum.md) | - | models/AccountTakeoverError.ts:59 | +| `message` | `string` | - | models/AccountTakeoverError.ts:60 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/AccountTakeoverNameProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/AccountTakeoverNameProperties.md new file mode 100644 index 00000000..10962961 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/AccountTakeoverNameProperties.md @@ -0,0 +1,13 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountTakeoverNameProperties + +# Interface: AccountTakeoverNameProperties + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/AccountTakeoverSiteInfoProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/AccountTakeoverSiteInfoProperties.md new file mode 100644 index 00000000..d71f3a12 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/AccountTakeoverSiteInfoProperties.md @@ -0,0 +1,12 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountTakeoverSiteInfoProperties + +# Interface: AccountTakeoverSiteInfoProperties + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/AccountTakeoverTransactionDetailsProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/AccountTakeoverTransactionDetailsProperties.md new file mode 100644 index 00000000..e75fc423 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/AccountTakeoverTransactionDetailsProperties.md @@ -0,0 +1,15 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountTakeoverTransactionDetailsProperties + +# Interface: AccountTakeoverTransactionDetailsProperties + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/AccountTakeoverUnauthorizedErrorProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/AccountTakeoverUnauthorizedErrorProperties.md new file mode 100644 index 00000000..9e28eaf8 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/AccountTakeoverUnauthorizedErrorProperties.md @@ -0,0 +1,10 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountTakeoverUnauthorizedErrorProperties + +# Interface: AccountTakeoverUnauthorizedErrorProperties + +## Properties + +| Property | Type | Description | Source | +| :------ | :------ | :------ | :------ | +| `code` | [`AccountTakeoverUnauthorizedErrorCodeEnum`](../type-aliases/AccountTakeoverUnauthorizedErrorCodeEnum.md) | - | models/AccountTakeoverUnauthorizedError.ts:61 | +| `message` | `string` | - | models/AccountTakeoverUnauthorizedError.ts:62 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/AccountTransactionProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/AccountTransactionProperties.md new file mode 100644 index 00000000..b1edeb82 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/AccountTransactionProperties.md @@ -0,0 +1,12 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountTransactionProperties + +# Interface: AccountTransactionProperties + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/AccountUpdateNotFoundErrorProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/AccountUpdateNotFoundErrorProperties.md new file mode 100644 index 00000000..6fcfe87d --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/AccountUpdateNotFoundErrorProperties.md @@ -0,0 +1,10 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountUpdateNotFoundErrorProperties + +# Interface: AccountUpdateNotFoundErrorProperties + +## Properties + +| Property | Type | Description | Source | +| :------ | :------ | :------ | :------ | +| `code` | [`AccountUpdateNotFoundErrorCodeEnum`](../type-aliases/AccountUpdateNotFoundErrorCodeEnum.md) | - | models/AccountUpdateNotFoundError.ts:61 | +| `message` | `string` | - | models/AccountUpdateNotFoundError.ts:62 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/AccountUpdateRequestProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/AccountUpdateRequestProperties.md new file mode 100644 index 00000000..2d5096b3 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/AccountUpdateRequestProperties.md @@ -0,0 +1,14 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AccountUpdateRequestProperties + +# Interface: AccountUpdateRequestProperties + +## Extended By + +- [`MultiFactorAuthenticationUpdateProperties`](MultiFactorAuthenticationUpdateProperties.md) +- [`RemediationUpdateProperties`](RemediationUpdateProperties.md) + +## Properties + +| Property | Type | Description | Source | +| :------ | :------ | :------ | :------ | +| `riskId` | `string` | - | models/AccountUpdateRequest.ts:44 | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.AccountUpdateResponseProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/AccountUpdateResponseProperties.md similarity index 53% rename from release/fraudPreventionV2/docs/models/interfaces/interface.AccountUpdateResponseProperties.md rename to release/fraudPreventionV2/src/docs/models/interfaces/AccountUpdateResponseProperties.md index e001c755..eab98be8 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.AccountUpdateResponseProperties.md +++ b/release/fraudPreventionV2/src/docs/models/interfaces/AccountUpdateResponseProperties.md @@ -4,6 +4,6 @@ ## Properties -| Property | Type | -| :-------- | :------- | -| `riskId`? | `string` | +| Property | Type | Description | Source | +| :------ | :------ | :------ | :------ | +| `riskId?` | `string` | - | models/AccountUpdateResponse.ts:37 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/AddressProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/AddressProperties.md new file mode 100644 index 00000000..b6946c36 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/AddressProperties.md @@ -0,0 +1,15 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AddressProperties + +# Interface: AddressProperties + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/AirProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/AirProperties.md new file mode 100644 index 00000000..97cd6e9a --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/AirProperties.md @@ -0,0 +1,23 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AirProperties + +# Interface: AirProperties + +## Extends + +- [`TravelProductProperties`](TravelProductProperties.md) + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/AirSegmentProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/AirSegmentProperties.md new file mode 100644 index 00000000..fb5dc5c9 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/AirSegmentProperties.md @@ -0,0 +1,13 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AirSegmentProperties + +# Interface: AirSegmentProperties + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/AmountProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/AmountProperties.md new file mode 100644 index 00000000..be4e364e --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/AmountProperties.md @@ -0,0 +1,10 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AmountProperties + +# Interface: AmountProperties + +## Properties + +| Property | Type | Description | Source | +| :------ | :------ | :------ | :------ | +| `currencyCode` | `string` | - | models/Amount.ts:44 | +| `value` | `number` | - | models/Amount.ts:43 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/AuthorizeProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/AuthorizeProperties.md new file mode 100644 index 00000000..15030473 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/AuthorizeProperties.md @@ -0,0 +1,11 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AuthorizeProperties + +# Interface: AuthorizeProperties + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/AuthorizeReversalProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/AuthorizeReversalProperties.md new file mode 100644 index 00000000..e3576cfd --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/AuthorizeReversalProperties.md @@ -0,0 +1,11 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > AuthorizeReversalProperties + +# Interface: AuthorizeReversalProperties + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/BadGatewayErrorProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/BadGatewayErrorProperties.md new file mode 100644 index 00000000..4e7c5bd2 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/BadGatewayErrorProperties.md @@ -0,0 +1,10 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > BadGatewayErrorProperties + +# Interface: BadGatewayErrorProperties + +## Properties + +| Property | Type | Description | Source | +| :------ | :------ | :------ | :------ | +| `code` | [`BadGatewayErrorCodeEnum`](../type-aliases/BadGatewayErrorCodeEnum.md) | - | models/BadGatewayError.ts:59 | +| `message` | `string` | - | models/BadGatewayError.ts:60 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/BadRequestErrorAllOfCausesProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/BadRequestErrorAllOfCausesProperties.md new file mode 100644 index 00000000..ff388038 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/BadRequestErrorAllOfCausesProperties.md @@ -0,0 +1,11 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > BadRequestErrorAllOfCausesProperties + +# Interface: BadRequestErrorAllOfCausesProperties + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/BadRequestErrorProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/BadRequestErrorProperties.md new file mode 100644 index 00000000..0c5983f0 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/BadRequestErrorProperties.md @@ -0,0 +1,11 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > BadRequestErrorProperties + +# Interface: BadRequestErrorProperties + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/CancellationReasonProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/CancellationReasonProperties.md new file mode 100644 index 00000000..6465541f --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/CancellationReasonProperties.md @@ -0,0 +1,12 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > CancellationReasonProperties + +# Interface: CancellationReasonProperties + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/CaptureProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/CaptureProperties.md new file mode 100644 index 00000000..4196aadb --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/CaptureProperties.md @@ -0,0 +1,11 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > CaptureProperties + +# Interface: CaptureProperties + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/CarProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/CarProperties.md new file mode 100644 index 00000000..93d3d394 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/CarProperties.md @@ -0,0 +1,21 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > CarProperties + +# Interface: CarProperties + +## Extends + +- [`TravelProductProperties`](TravelProductProperties.md) + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/ChallengeDetailProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/ChallengeDetailProperties.md new file mode 100644 index 00000000..f358c820 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/ChallengeDetailProperties.md @@ -0,0 +1,11 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > ChallengeDetailProperties + +# Interface: ChallengeDetailProperties + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/ChargebackDetailProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/ChargebackDetailProperties.md new file mode 100644 index 00000000..a6de2c4a --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/ChargebackDetailProperties.md @@ -0,0 +1,13 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > ChargebackDetailProperties + +# Interface: ChargebackDetailProperties + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/ChargebackFeedbackProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/ChargebackFeedbackProperties.md new file mode 100644 index 00000000..a713deb3 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/ChargebackFeedbackProperties.md @@ -0,0 +1,14 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > ChargebackFeedbackProperties + +# Interface: ChargebackFeedbackProperties + +## Extends + +- [`OrderPurchaseUpdateRequestProperties`](OrderPurchaseUpdateRequestProperties.md) + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/CreditCardProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/CreditCardProperties.md new file mode 100644 index 00000000..c00eaa2c --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/CreditCardProperties.md @@ -0,0 +1,32 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > CreditCardProperties + +# Interface: CreditCardProperties + +## Extends + +- [`PaymentProperties`](PaymentProperties.md) + +## Properties + +| Property | Type | Description | Inheritance | Source | +| :------ | :------ | :------ | :------ | :------ | +| `authorizedAmount?` | [`Amount`](../classes/Amount.md) | - | [`PaymentProperties`](PaymentProperties.md).`authorizedAmount` | models/Payment.ts:159 | +| `billingAddress` | [`PaymentBillingAddress`](../classes/PaymentBillingAddress.md) | - | [`PaymentProperties`](PaymentProperties.md).`billingAddress` | models/Payment.ts:157 | +| `billingEmailAddress` | `string` | - | [`PaymentProperties`](PaymentProperties.md).`billingEmailAddress` | models/Payment.ts:158 | +| `billingName` | [`Name`](../classes/Name.md) | - | [`PaymentProperties`](PaymentProperties.md).`billingName` | models/Payment.ts:156 | +| `brand` | [`PaymentBrandEnum`](../type-aliases/PaymentBrandEnum.md) | - | [`PaymentProperties`](PaymentProperties.md).`brand` | models/Payment.ts:154 | +| `cardAuthenticationFailureCount?` | `number` | - | - | models/CreditCard.ts:143 | +| `cardAvsResponse?` | `string` | - | - | models/CreditCard.ts:139 | +| `cardCvvResponse?` | `string` | - | - | models/CreditCard.ts:140 | +| `cardNumber` | `string` | - | - | models/CreditCard.ts:134 | +| `cardType` | [`CreditCardCardTypeEnum`](../type-aliases/CreditCardCardTypeEnum.md) | - | - | models/CreditCard.ts:133 | +| `electronicCommerceIndicator?` | `string` | - | - | models/CreditCard.ts:136 | +| `expiryDate` | `Date` | - | - | models/CreditCard.ts:135 | +| `merchantOrderCode?` | `string` | - | - | models/CreditCard.ts:142 | +| `operations?` | [`Operations`](../classes/Operations.md) | - | [`PaymentProperties`](PaymentProperties.md).`operations` | models/Payment.ts:162 | +| `reason?` | [`PaymentReason`](../type-aliases/PaymentReason.md) | - | [`PaymentProperties`](PaymentProperties.md).`reason` | models/Payment.ts:155 | +| `telephones` | [`Telephone`](../classes/Telephone.md)[] | - | - | models/CreditCard.ts:141 | +| `threeDigitsSecureCriteria?` | [`PaymentThreeDSCriteria`](../classes/PaymentThreeDSCriteria.md) | - | [`PaymentProperties`](PaymentProperties.md).`threeDigitsSecureCriteria` | models/Payment.ts:161 | +| `verifiedAmount?` | [`Amount`](../classes/Amount.md) | - | [`PaymentProperties`](PaymentProperties.md).`verifiedAmount` | models/Payment.ts:160 | +| `virtualCreditCardFlag?` | `boolean` | - | - | models/CreditCard.ts:137 | +| `walletType?` | `string` | - | - | models/CreditCard.ts:138 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/CruiseProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/CruiseProperties.md new file mode 100644 index 00000000..ded7a326 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/CruiseProperties.md @@ -0,0 +1,22 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > CruiseProperties + +# Interface: CruiseProperties + +## Extends + +- [`TravelProductProperties`](TravelProductProperties.md) + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/CurrentUserSessionProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/CurrentUserSessionProperties.md new file mode 100644 index 00000000..fc4117ce --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/CurrentUserSessionProperties.md @@ -0,0 +1,11 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > CurrentUserSessionProperties + +# Interface: CurrentUserSessionProperties + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/CustomerAccountAddressProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/CustomerAccountAddressProperties.md new file mode 100644 index 00000000..86c2a35a --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/CustomerAccountAddressProperties.md @@ -0,0 +1,15 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > CustomerAccountAddressProperties + +# Interface: CustomerAccountAddressProperties + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/CustomerAccountProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/CustomerAccountProperties.md new file mode 100644 index 00000000..82a474db --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/CustomerAccountProperties.md @@ -0,0 +1,15 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > CustomerAccountProperties + +# Interface: CustomerAccountProperties + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/DeviceDetailsProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/DeviceDetailsProperties.md new file mode 100644 index 00000000..6ca9751c --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/DeviceDetailsProperties.md @@ -0,0 +1,11 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > DeviceDetailsProperties + +# Interface: DeviceDetailsProperties + +## Properties + +| Property | Type | Description | Source | +| :------ | :------ | :------ | :------ | +| `deviceBox?` | `string` | - | models/DeviceDetails.ts:50 | +| `ipAddress` | `string` | - | models/DeviceDetails.ts:51 | +| `source?` | `string` | - | models/DeviceDetails.ts:49 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/DirectDebitProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/DirectDebitProperties.md new file mode 100644 index 00000000..90bd98d4 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/DirectDebitProperties.md @@ -0,0 +1,24 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > DirectDebitProperties + +# Interface: DirectDebitProperties + +## Extends + +- [`PaymentProperties`](PaymentProperties.md) + +## Properties + +| Property | Type | Description | Inheritance | Source | +| :------ | :------ | :------ | :------ | :------ | +| `accountNumber` | `string` | - | - | models/DirectDebit.ts:72 | +| `authorizedAmount?` | [`Amount`](../classes/Amount.md) | - | [`PaymentProperties`](PaymentProperties.md).`authorizedAmount` | models/Payment.ts:159 | +| `billingAddress` | [`PaymentBillingAddress`](../classes/PaymentBillingAddress.md) | - | [`PaymentProperties`](PaymentProperties.md).`billingAddress` | models/Payment.ts:157 | +| `billingEmailAddress` | `string` | - | [`PaymentProperties`](PaymentProperties.md).`billingEmailAddress` | models/Payment.ts:158 | +| `billingName` | [`Name`](../classes/Name.md) | - | [`PaymentProperties`](PaymentProperties.md).`billingName` | models/Payment.ts:156 | +| `brand` | [`PaymentBrandEnum`](../type-aliases/PaymentBrandEnum.md) | - | [`PaymentProperties`](PaymentProperties.md).`brand` | models/Payment.ts:154 | +| `operations?` | [`Operations`](../classes/Operations.md) | - | [`PaymentProperties`](PaymentProperties.md).`operations` | models/Payment.ts:162 | +| `reason?` | [`PaymentReason`](../type-aliases/PaymentReason.md) | - | [`PaymentProperties`](PaymentProperties.md).`reason` | models/Payment.ts:155 | +| `routingNumber` | `string` | - | - | models/DirectDebit.ts:71 | +| `telephones` | [`Telephone`](../classes/Telephone.md)[] | - | - | models/DirectDebit.ts:73 | +| `threeDigitsSecureCriteria?` | [`PaymentThreeDSCriteria`](../classes/PaymentThreeDSCriteria.md) | - | [`PaymentProperties`](PaymentProperties.md).`threeDigitsSecureCriteria` | models/Payment.ts:161 | +| `verifiedAmount?` | [`Amount`](../classes/Amount.md) | - | [`PaymentProperties`](PaymentProperties.md).`verifiedAmount` | models/Payment.ts:160 | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.EmailProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/EmailProperties.md similarity index 50% rename from release/fraudPreventionV2/docs/models/interfaces/interface.EmailProperties.md rename to release/fraudPreventionV2/src/docs/models/interfaces/EmailProperties.md index f2d15596..16fdadc5 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.EmailProperties.md +++ b/release/fraudPreventionV2/src/docs/models/interfaces/EmailProperties.md @@ -4,6 +4,6 @@ ## Properties -| Property | Type | -| :-------------- | :------- | -| `emailAddress`? | `string` | +| Property | Type | Description | Source | +| :------ | :------ | :------ | :------ | +| `emailAddress?` | `string` | - | models/Email.ts:40 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/ForbiddenErrorProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/ForbiddenErrorProperties.md new file mode 100644 index 00000000..10c2fa76 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/ForbiddenErrorProperties.md @@ -0,0 +1,10 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > ForbiddenErrorProperties + +# Interface: ForbiddenErrorProperties + +## Properties + +| Property | Type | Description | Source | +| :------ | :------ | :------ | :------ | +| `code` | [`ForbiddenErrorCodeEnum`](../type-aliases/ForbiddenErrorCodeEnum.md) | - | models/ForbiddenError.ts:59 | +| `message` | `string` | - | models/ForbiddenError.ts:60 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/GatewayTimeoutErrorProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/GatewayTimeoutErrorProperties.md new file mode 100644 index 00000000..49ed0683 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/GatewayTimeoutErrorProperties.md @@ -0,0 +1,10 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > GatewayTimeoutErrorProperties + +# Interface: GatewayTimeoutErrorProperties + +## Properties + +| Property | Type | Description | Source | +| :------ | :------ | :------ | :------ | +| `code` | [`GatewayTimeoutErrorCodeEnum`](../type-aliases/GatewayTimeoutErrorCodeEnum.md) | - | models/GatewayTimeoutError.ts:59 | +| `message` | `string` | - | models/GatewayTimeoutError.ts:60 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/GiftCardProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/GiftCardProperties.md new file mode 100644 index 00000000..9d0debbc --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/GiftCardProperties.md @@ -0,0 +1,24 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > GiftCardProperties + +# Interface: GiftCardProperties + +## Extends + +- [`PaymentProperties`](PaymentProperties.md) + +## Properties + +| Property | Type | Description | Inheritance | Source | +| :------ | :------ | :------ | :------ | :------ | +| `authorizedAmount?` | [`Amount`](../classes/Amount.md) | - | [`PaymentProperties`](PaymentProperties.md).`authorizedAmount` | models/Payment.ts:159 | +| `billingAddress` | [`PaymentBillingAddress`](../classes/PaymentBillingAddress.md) | - | [`PaymentProperties`](PaymentProperties.md).`billingAddress` | models/Payment.ts:157 | +| `billingEmailAddress` | `string` | - | [`PaymentProperties`](PaymentProperties.md).`billingEmailAddress` | models/Payment.ts:158 | +| `billingName` | [`Name`](../classes/Name.md) | - | [`PaymentProperties`](PaymentProperties.md).`billingName` | models/Payment.ts:156 | +| `brand` | [`PaymentBrandEnum`](../type-aliases/PaymentBrandEnum.md) | - | [`PaymentProperties`](PaymentProperties.md).`brand` | models/Payment.ts:154 | +| `cardHolderName` | `string` | - | - | models/GiftCard.ts:66 | +| `cardNumber` | `string` | - | - | models/GiftCard.ts:65 | +| `operations?` | [`Operations`](../classes/Operations.md) | - | [`PaymentProperties`](PaymentProperties.md).`operations` | models/Payment.ts:162 | +| `pin` | `string` | - | - | models/GiftCard.ts:67 | +| `reason?` | [`PaymentReason`](../type-aliases/PaymentReason.md) | - | [`PaymentProperties`](PaymentProperties.md).`reason` | models/Payment.ts:155 | +| `threeDigitsSecureCriteria?` | [`PaymentThreeDSCriteria`](../classes/PaymentThreeDSCriteria.md) | - | [`PaymentProperties`](PaymentProperties.md).`threeDigitsSecureCriteria` | models/Payment.ts:161 | +| `verifiedAmount?` | [`Amount`](../classes/Amount.md) | - | [`PaymentProperties`](PaymentProperties.md).`verifiedAmount` | models/Payment.ts:160 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/HotelAddressProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/HotelAddressProperties.md new file mode 100644 index 00000000..bdf2fe00 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/HotelAddressProperties.md @@ -0,0 +1,15 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > HotelAddressProperties + +# Interface: HotelAddressProperties + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/HotelProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/HotelProperties.md new file mode 100644 index 00000000..ba9d493f --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/HotelProperties.md @@ -0,0 +1,24 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > HotelProperties + +# Interface: HotelProperties + +## Extends + +- [`TravelProductProperties`](TravelProductProperties.md) + +## 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 | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.InsultDetailProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/InsultDetailProperties.md similarity index 50% rename from release/fraudPreventionV2/docs/models/interfaces/interface.InsultDetailProperties.md rename to release/fraudPreventionV2/src/docs/models/interfaces/InsultDetailProperties.md index 313840c4..206fd99e 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.InsultDetailProperties.md +++ b/release/fraudPreventionV2/src/docs/models/interfaces/InsultDetailProperties.md @@ -4,6 +4,6 @@ ## Properties -| Property | Type | -| :------------------------ | :----- | -| `insultReportedDateTime`? | `Date` | +| Property | Type | Description | Source | +| :------ | :------ | :------ | :------ | +| `insultReportedDateTime?` | `Date` | - | models/InsultDetail.ts:40 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/InsultFeedbackProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/InsultFeedbackProperties.md new file mode 100644 index 00000000..8b21bd1f --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/InsultFeedbackProperties.md @@ -0,0 +1,14 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > InsultFeedbackProperties + +# Interface: InsultFeedbackProperties + +## Extends + +- [`OrderPurchaseUpdateRequestProperties`](OrderPurchaseUpdateRequestProperties.md) + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/InsuranceProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/InsuranceProperties.md new file mode 100644 index 00000000..7deee4da --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/InsuranceProperties.md @@ -0,0 +1,17 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > InsuranceProperties + +# Interface: InsuranceProperties + +## Extends + +- [`TravelProductProperties`](TravelProductProperties.md) + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/InternalServerErrorProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/InternalServerErrorProperties.md new file mode 100644 index 00000000..9eefdefb --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/InternalServerErrorProperties.md @@ -0,0 +1,10 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > InternalServerErrorProperties + +# Interface: InternalServerErrorProperties + +## Properties + +| Property | Type | Description | Source | +| :------ | :------ | :------ | :------ | +| `code` | [`InternalServerErrorCodeEnum`](../type-aliases/InternalServerErrorCodeEnum.md) | - | models/InternalServerError.ts:59 | +| `message` | `string` | - | models/InternalServerError.ts:60 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/InternetBankPaymentProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/InternetBankPaymentProperties.md new file mode 100644 index 00000000..684ff38e --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/InternetBankPaymentProperties.md @@ -0,0 +1,24 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > InternetBankPaymentProperties + +# Interface: InternetBankPaymentProperties + +## Extends + +- [`PaymentProperties`](PaymentProperties.md) + +## Properties + +| Property | Type | Description | Inheritance | Source | +| :------ | :------ | :------ | :------ | :------ | +| `authorizedAmount?` | [`Amount`](../classes/Amount.md) | - | [`PaymentProperties`](PaymentProperties.md).`authorizedAmount` | models/Payment.ts:159 | +| `bankBranchCode` | `string` | - | - | models/InternetBankPayment.ts:73 | +| `bankId` | `string` | - | - | models/InternetBankPayment.ts:72 | +| `billingAddress` | [`PaymentBillingAddress`](../classes/PaymentBillingAddress.md) | - | [`PaymentProperties`](PaymentProperties.md).`billingAddress` | models/Payment.ts:157 | +| `billingEmailAddress` | `string` | - | [`PaymentProperties`](PaymentProperties.md).`billingEmailAddress` | models/Payment.ts:158 | +| `billingName` | [`Name`](../classes/Name.md) | - | [`PaymentProperties`](PaymentProperties.md).`billingName` | models/Payment.ts:156 | +| `brand` | [`PaymentBrandEnum`](../type-aliases/PaymentBrandEnum.md) | - | [`PaymentProperties`](PaymentProperties.md).`brand` | models/Payment.ts:154 | +| `operations?` | [`Operations`](../classes/Operations.md) | - | [`PaymentProperties`](PaymentProperties.md).`operations` | models/Payment.ts:162 | +| `reason?` | [`PaymentReason`](../type-aliases/PaymentReason.md) | - | [`PaymentProperties`](PaymentProperties.md).`reason` | models/Payment.ts:155 | +| `telephones` | [`Telephone`](../classes/Telephone.md)[] | - | - | models/InternetBankPayment.ts:74 | +| `threeDigitsSecureCriteria?` | [`PaymentThreeDSCriteria`](../classes/PaymentThreeDSCriteria.md) | - | [`PaymentProperties`](PaymentProperties.md).`threeDigitsSecureCriteria` | models/Payment.ts:161 | +| `verifiedAmount?` | [`Amount`](../classes/Amount.md) | - | [`PaymentProperties`](PaymentProperties.md).`verifiedAmount` | models/Payment.ts:160 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/IssuedRefundUpdateDetailsProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/IssuedRefundUpdateDetailsProperties.md new file mode 100644 index 00000000..a8ba3b5f --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/IssuedRefundUpdateDetailsProperties.md @@ -0,0 +1,10 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > IssuedRefundUpdateDetailsProperties + +# Interface: IssuedRefundUpdateDetailsProperties + +## Properties + +| Property | Type | Description | Source | +| :------ | :------ | :------ | :------ | +| `refundIssuedAmount` | [`Amount`](../classes/Amount.md) | - | models/IssuedRefundUpdateDetails.ts:53 | +| `refundIssuedDateTime` | `Date` | - | models/IssuedRefundUpdateDetails.ts:52 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/IssuedRefundUpdateProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/IssuedRefundUpdateProperties.md new file mode 100644 index 00000000..a4fb6a93 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/IssuedRefundUpdateProperties.md @@ -0,0 +1,14 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > IssuedRefundUpdateProperties + +# Interface: IssuedRefundUpdateProperties + +## Extends + +- [`RefundUpdateProperties`](RefundUpdateProperties.md) + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/LoginTransactionDetailsProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/LoginTransactionDetailsProperties.md new file mode 100644 index 00000000..a2a81bcd --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/LoginTransactionDetailsProperties.md @@ -0,0 +1,19 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > LoginTransactionDetailsProperties + +# Interface: LoginTransactionDetailsProperties + +## Extends + +- [`AccountTakeoverTransactionDetailsProperties`](AccountTakeoverTransactionDetailsProperties.md) + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/ModelErrorProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/ModelErrorProperties.md new file mode 100644 index 00000000..2f97f47d --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/ModelErrorProperties.md @@ -0,0 +1,10 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > ModelErrorProperties + +# Interface: ModelErrorProperties + +## Properties + +| Property | Type | Description | Source | +| :------ | :------ | :------ | :------ | +| `code` | [`ModelErrorCodeEnum`](../type-aliases/ModelErrorCodeEnum.md) | - | models/ModelError.ts:59 | +| `message` | `string` | - | models/ModelError.ts:60 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/MultiFactorAuthenticationAttemptProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/MultiFactorAuthenticationAttemptProperties.md new file mode 100644 index 00000000..6bed4b0a --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/MultiFactorAuthenticationAttemptProperties.md @@ -0,0 +1,17 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > MultiFactorAuthenticationAttemptProperties + +# Interface: MultiFactorAuthenticationAttemptProperties + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/MultiFactorAuthenticationUpdateProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/MultiFactorAuthenticationUpdateProperties.md new file mode 100644 index 00000000..26f76e90 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/MultiFactorAuthenticationUpdateProperties.md @@ -0,0 +1,14 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > MultiFactorAuthenticationUpdateProperties + +# Interface: MultiFactorAuthenticationUpdateProperties + +## Extends + +- [`AccountUpdateRequestProperties`](AccountUpdateRequestProperties.md) + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/NameProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/NameProperties.md new file mode 100644 index 00000000..15e8896e --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/NameProperties.md @@ -0,0 +1,13 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > NameProperties + +# Interface: NameProperties + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/NotFoundErrorProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/NotFoundErrorProperties.md new file mode 100644 index 00000000..956747cc --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/NotFoundErrorProperties.md @@ -0,0 +1,10 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > NotFoundErrorProperties + +# Interface: NotFoundErrorProperties + +## Properties + +| Property | Type | Description | Source | +| :------ | :------ | :------ | :------ | +| `code` | [`NotFoundErrorCodeEnum`](../type-aliases/NotFoundErrorCodeEnum.md) | - | models/NotFoundError.ts:59 | +| `message` | `string` | - | models/NotFoundError.ts:60 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/OperationsProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/OperationsProperties.md new file mode 100644 index 00000000..204da09c --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/OperationsProperties.md @@ -0,0 +1,13 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > OperationsProperties + +# Interface: OperationsProperties + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/OrderPurchaseScreenRequestProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/OrderPurchaseScreenRequestProperties.md new file mode 100644 index 00000000..1942bc1e --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/OrderPurchaseScreenRequestProperties.md @@ -0,0 +1,9 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > OrderPurchaseScreenRequestProperties + +# Interface: OrderPurchaseScreenRequestProperties + +## Properties + +| Property | Type | Description | Source | +| :------ | :------ | :------ | :------ | +| `transaction` | [`OrderPurchaseTransaction`](../classes/OrderPurchaseTransaction.md) | - | models/OrderPurchaseScreenRequest.ts:41 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/OrderPurchaseScreenResponseProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/OrderPurchaseScreenResponseProperties.md new file mode 100644 index 00000000..f5ed60cf --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/OrderPurchaseScreenResponseProperties.md @@ -0,0 +1,10 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > OrderPurchaseScreenResponseProperties + +# Interface: OrderPurchaseScreenResponseProperties + +## Properties + +| Property | Type | Description | Source | +| :------ | :------ | :------ | :------ | +| `decision?` | [`FraudDecision`](../type-aliases/FraudDecision.md) | - | models/OrderPurchaseScreenResponse.ts:44 | +| `riskId?` | `string` | - | models/OrderPurchaseScreenResponse.ts:43 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/OrderPurchaseTransactionProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/OrderPurchaseTransactionProperties.md new file mode 100644 index 00000000..57b17a79 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/OrderPurchaseTransactionProperties.md @@ -0,0 +1,12 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > OrderPurchaseTransactionProperties + +# Interface: OrderPurchaseTransactionProperties + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/OrderPurchaseUpdateNotFoundErrorProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/OrderPurchaseUpdateNotFoundErrorProperties.md new file mode 100644 index 00000000..86f3ba3e --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/OrderPurchaseUpdateNotFoundErrorProperties.md @@ -0,0 +1,10 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > OrderPurchaseUpdateNotFoundErrorProperties + +# Interface: OrderPurchaseUpdateNotFoundErrorProperties + +## Properties + +| Property | Type | Description | Source | +| :------ | :------ | :------ | :------ | +| `code` | [`OrderPurchaseUpdateNotFoundErrorCodeEnum`](../type-aliases/OrderPurchaseUpdateNotFoundErrorCodeEnum.md) | - | models/OrderPurchaseUpdateNotFoundError.ts:61 | +| `message` | `string` | - | models/OrderPurchaseUpdateNotFoundError.ts:62 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/OrderPurchaseUpdateRequestProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/OrderPurchaseUpdateRequestProperties.md new file mode 100644 index 00000000..26947be5 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/OrderPurchaseUpdateRequestProperties.md @@ -0,0 +1,17 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > OrderPurchaseUpdateRequestProperties + +# Interface: OrderPurchaseUpdateRequestProperties + +## Extended By + +- [`ChargebackFeedbackProperties`](ChargebackFeedbackProperties.md) +- [`InsultFeedbackProperties`](InsultFeedbackProperties.md) +- [`OrderUpdateProperties`](OrderUpdateProperties.md) +- [`PaymentUpdateProperties`](PaymentUpdateProperties.md) +- [`RefundUpdateProperties`](RefundUpdateProperties.md) + +## Properties + +| Property | Type | Description | Source | +| :------ | :------ | :------ | :------ | +| `riskId` | `string` | - | models/OrderPurchaseUpdateRequest.ts:42 | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.OrderPurchaseUpdateResponseProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/OrderPurchaseUpdateResponseProperties.md similarity index 54% rename from release/fraudPreventionV2/docs/models/interfaces/interface.OrderPurchaseUpdateResponseProperties.md rename to release/fraudPreventionV2/src/docs/models/interfaces/OrderPurchaseUpdateResponseProperties.md index f6cea8c9..a6aea29d 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.OrderPurchaseUpdateResponseProperties.md +++ b/release/fraudPreventionV2/src/docs/models/interfaces/OrderPurchaseUpdateResponseProperties.md @@ -4,6 +4,6 @@ ## Properties -| Property | Type | -| :-------- | :------- | -| `riskId`? | `string` | +| Property | Type | Description | Source | +| :------ | :------ | :------ | :------ | +| `riskId?` | `string` | - | models/OrderPurchaseUpdateResponse.ts:39 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/OrderUpdateProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/OrderUpdateProperties.md new file mode 100644 index 00000000..197ae04e --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/OrderUpdateProperties.md @@ -0,0 +1,16 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > OrderUpdateProperties + +# Interface: OrderUpdateProperties + +## Extends + +- [`OrderPurchaseUpdateRequestProperties`](OrderPurchaseUpdateRequestProperties.md) + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/PayPalProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/PayPalProperties.md new file mode 100644 index 00000000..b23e9c31 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/PayPalProperties.md @@ -0,0 +1,24 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > PayPalProperties + +# Interface: PayPalProperties + +## Extends + +- [`PaymentProperties`](PaymentProperties.md) + +## Properties + +| Property | Type | Description | Inheritance | Source | +| :------ | :------ | :------ | :------ | :------ | +| `authorizedAmount?` | [`Amount`](../classes/Amount.md) | - | [`PaymentProperties`](PaymentProperties.md).`authorizedAmount` | models/Payment.ts:159 | +| `billingAddress` | [`PaymentBillingAddress`](../classes/PaymentBillingAddress.md) | - | [`PaymentProperties`](PaymentProperties.md).`billingAddress` | models/Payment.ts:157 | +| `billingEmailAddress` | `string` | - | [`PaymentProperties`](PaymentProperties.md).`billingEmailAddress` | models/Payment.ts:158 | +| `billingName` | [`Name`](../classes/Name.md) | - | [`PaymentProperties`](PaymentProperties.md).`billingName` | models/Payment.ts:156 | +| `brand` | [`PaymentBrandEnum`](../type-aliases/PaymentBrandEnum.md) | - | [`PaymentProperties`](PaymentProperties.md).`brand` | models/Payment.ts:154 | +| `merchantOrderCode?` | `string` | - | - | models/PayPal.ts:67 | +| `operations?` | [`Operations`](../classes/Operations.md) | - | [`PaymentProperties`](PaymentProperties.md).`operations` | models/Payment.ts:162 | +| `payerId` | `string` | - | - | models/PayPal.ts:65 | +| `reason?` | [`PaymentReason`](../type-aliases/PaymentReason.md) | - | [`PaymentProperties`](PaymentProperties.md).`reason` | models/Payment.ts:155 | +| `threeDigitsSecureCriteria?` | [`PaymentThreeDSCriteria`](../classes/PaymentThreeDSCriteria.md) | - | [`PaymentProperties`](PaymentProperties.md).`threeDigitsSecureCriteria` | models/Payment.ts:161 | +| `transactionId` | `string` | - | - | models/PayPal.ts:66 | +| `verifiedAmount?` | [`Amount`](../classes/Amount.md) | - | [`PaymentProperties`](PaymentProperties.md).`verifiedAmount` | models/Payment.ts:160 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/PaymentBillingAddressProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/PaymentBillingAddressProperties.md new file mode 100644 index 00000000..ad9c90bb --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/PaymentBillingAddressProperties.md @@ -0,0 +1,15 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > PaymentBillingAddressProperties + +# Interface: PaymentBillingAddressProperties + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/PaymentOperationProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/PaymentOperationProperties.md new file mode 100644 index 00000000..5e160302 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/PaymentOperationProperties.md @@ -0,0 +1,11 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > PaymentOperationProperties + +# Interface: PaymentOperationProperties + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/PaymentOutcomeProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/PaymentOutcomeProperties.md new file mode 100644 index 00000000..0888f5c6 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/PaymentOutcomeProperties.md @@ -0,0 +1,11 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > PaymentOutcomeProperties + +# Interface: PaymentOutcomeProperties + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/PaymentProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/PaymentProperties.md new file mode 100644 index 00000000..85d0df85 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/PaymentProperties.md @@ -0,0 +1,26 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > PaymentProperties + +# Interface: PaymentProperties + +## Extended By + +- [`CreditCardProperties`](CreditCardProperties.md) +- [`DirectDebitProperties`](DirectDebitProperties.md) +- [`GiftCardProperties`](GiftCardProperties.md) +- [`InternetBankPaymentProperties`](InternetBankPaymentProperties.md) +- [`PayPalProperties`](PayPalProperties.md) +- [`PointsProperties`](PointsProperties.md) + +## Properties + +| Property | Type | Description | Source | +| :------ | :------ | :------ | :------ | +| `authorizedAmount?` | [`Amount`](../classes/Amount.md) | - | models/Payment.ts:159 | +| `billingAddress` | [`PaymentBillingAddress`](../classes/PaymentBillingAddress.md) | - | models/Payment.ts:157 | +| `billingEmailAddress` | `string` | - | models/Payment.ts:158 | +| `billingName` | [`Name`](../classes/Name.md) | - | models/Payment.ts:156 | +| `brand` | [`PaymentBrandEnum`](../type-aliases/PaymentBrandEnum.md) | - | models/Payment.ts:154 | +| `operations?` | [`Operations`](../classes/Operations.md) | - | models/Payment.ts:162 | +| `reason?` | [`PaymentReason`](../type-aliases/PaymentReason.md) | - | models/Payment.ts:155 | +| `threeDigitsSecureCriteria?` | [`PaymentThreeDSCriteria`](../classes/PaymentThreeDSCriteria.md) | - | models/Payment.ts:161 | +| `verifiedAmount?` | [`Amount`](../classes/Amount.md) | - | models/Payment.ts:160 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/PaymentThreeDSCriteriaProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/PaymentThreeDSCriteriaProperties.md new file mode 100644 index 00000000..104011ba --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/PaymentThreeDSCriteriaProperties.md @@ -0,0 +1,10 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > PaymentThreeDSCriteriaProperties + +# Interface: PaymentThreeDSCriteriaProperties + +## Properties + +| Property | Type | Description | Source | +| :------ | :------ | :------ | :------ | +| `probableFlag?` | `boolean` | - | models/PaymentThreeDSCriteria.ts:48 | +| `transactionModel?` | `string` | - | models/PaymentThreeDSCriteria.ts:49 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/PaymentUpdateProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/PaymentUpdateProperties.md new file mode 100644 index 00000000..fab89173 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/PaymentUpdateProperties.md @@ -0,0 +1,14 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > PaymentUpdateProperties + +# Interface: PaymentUpdateProperties + +## Extends + +- [`OrderPurchaseUpdateRequestProperties`](OrderPurchaseUpdateRequestProperties.md) + +## Properties + +| Property | Type | Description | Inheritance | Source | +| :------ | :------ | :------ | :------ | :------ | +| `merchantOrderCode` | `string` | - | - | models/PaymentUpdate.ts:49 | +| `riskId` | `string` | - | [`OrderPurchaseUpdateRequestProperties`](OrderPurchaseUpdateRequestProperties.md).`riskId` | models/OrderPurchaseUpdateRequest.ts:42 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/PointsProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/PointsProperties.md new file mode 100644 index 00000000..9508f159 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/PointsProperties.md @@ -0,0 +1,22 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > PointsProperties + +# Interface: PointsProperties + +## Extends + +- [`PaymentProperties`](PaymentProperties.md) + +## Properties + +| Property | Type | Description | Inheritance | Source | +| :------ | :------ | :------ | :------ | :------ | +| `accountId` | `string` | - | - | models/Points.ts:53 | +| `authorizedAmount?` | [`Amount`](../classes/Amount.md) | - | [`PaymentProperties`](PaymentProperties.md).`authorizedAmount` | models/Payment.ts:159 | +| `billingAddress` | [`PaymentBillingAddress`](../classes/PaymentBillingAddress.md) | - | [`PaymentProperties`](PaymentProperties.md).`billingAddress` | models/Payment.ts:157 | +| `billingEmailAddress` | `string` | - | [`PaymentProperties`](PaymentProperties.md).`billingEmailAddress` | models/Payment.ts:158 | +| `billingName` | [`Name`](../classes/Name.md) | - | [`PaymentProperties`](PaymentProperties.md).`billingName` | models/Payment.ts:156 | +| `brand` | [`PaymentBrandEnum`](../type-aliases/PaymentBrandEnum.md) | - | [`PaymentProperties`](PaymentProperties.md).`brand` | models/Payment.ts:154 | +| `operations?` | [`Operations`](../classes/Operations.md) | - | [`PaymentProperties`](PaymentProperties.md).`operations` | models/Payment.ts:162 | +| `reason?` | [`PaymentReason`](../type-aliases/PaymentReason.md) | - | [`PaymentProperties`](PaymentProperties.md).`reason` | models/Payment.ts:155 | +| `threeDigitsSecureCriteria?` | [`PaymentThreeDSCriteria`](../classes/PaymentThreeDSCriteria.md) | - | [`PaymentProperties`](PaymentProperties.md).`threeDigitsSecureCriteria` | models/Payment.ts:161 | +| `verifiedAmount?` | [`Amount`](../classes/Amount.md) | - | [`PaymentProperties`](PaymentProperties.md).`verifiedAmount` | models/Payment.ts:160 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/RailProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/RailProperties.md new file mode 100644 index 00000000..87d06837 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/RailProperties.md @@ -0,0 +1,19 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > RailProperties + +# Interface: RailProperties + +## Extends + +- [`TravelProductProperties`](TravelProductProperties.md) + +## 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 | diff --git a/release/fraudPreventionV2/docs/models/interfaces/interface.RailSegmentsOperatingCompanyProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/RailSegmentsOperatingCompanyProperties.md similarity index 53% rename from release/fraudPreventionV2/docs/models/interfaces/interface.RailSegmentsOperatingCompanyProperties.md rename to release/fraudPreventionV2/src/docs/models/interfaces/RailSegmentsOperatingCompanyProperties.md index 6ab15614..b7b9f5b0 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/interface.RailSegmentsOperatingCompanyProperties.md +++ b/release/fraudPreventionV2/src/docs/models/interfaces/RailSegmentsOperatingCompanyProperties.md @@ -4,6 +4,6 @@ ## Properties -| Property | Type | -| :--------------- | :------- | -| `marketingName`? | `string` | +| Property | Type | Description | Source | +| :------ | :------ | :------ | :------ | +| `marketingName?` | `string` | - | models/RailSegmentsOperatingCompany.ts:42 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/RailSegmentsProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/RailSegmentsProperties.md new file mode 100644 index 00000000..ac619e66 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/RailSegmentsProperties.md @@ -0,0 +1,14 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > RailSegmentsProperties + +# Interface: RailSegmentsProperties + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/RailwayStationDetailsProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/RailwayStationDetailsProperties.md new file mode 100644 index 00000000..f694db31 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/RailwayStationDetailsProperties.md @@ -0,0 +1,13 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > RailwayStationDetailsProperties + +# Interface: RailwayStationDetailsProperties + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/RefundProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/RefundProperties.md new file mode 100644 index 00000000..1c607178 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/RefundProperties.md @@ -0,0 +1,11 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > RefundProperties + +# Interface: RefundProperties + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/RefundUpdateProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/RefundUpdateProperties.md new file mode 100644 index 00000000..23396ca8 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/RefundUpdateProperties.md @@ -0,0 +1,13 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > RefundUpdateProperties + +# Interface: RefundUpdateProperties + +## Extends + +- [`OrderPurchaseUpdateRequestProperties`](OrderPurchaseUpdateRequestProperties.md) + +## Properties + +| Property | Type | Description | Inheritance | Source | +| :------ | :------ | :------ | :------ | :------ | +| `riskId` | `string` | - | [`OrderPurchaseUpdateRequestProperties`](OrderPurchaseUpdateRequestProperties.md).`riskId` | models/OrderPurchaseUpdateRequest.ts:42 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/RemediationUpdateActionProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/RemediationUpdateActionProperties.md new file mode 100644 index 00000000..73784af6 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/RemediationUpdateActionProperties.md @@ -0,0 +1,11 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > RemediationUpdateActionProperties + +# Interface: RemediationUpdateActionProperties + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/RemediationUpdateProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/RemediationUpdateProperties.md new file mode 100644 index 00000000..7c2c629b --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/RemediationUpdateProperties.md @@ -0,0 +1,14 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > RemediationUpdateProperties + +# Interface: RemediationUpdateProperties + +## Extends + +- [`AccountUpdateRequestProperties`](AccountUpdateRequestProperties.md) + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/RetryableOrderPurchaseScreenFailureProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/RetryableOrderPurchaseScreenFailureProperties.md new file mode 100644 index 00000000..d018bf07 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/RetryableOrderPurchaseScreenFailureProperties.md @@ -0,0 +1,10 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > RetryableOrderPurchaseScreenFailureProperties + +# Interface: RetryableOrderPurchaseScreenFailureProperties + +## Properties + +| Property | Type | Description | Source | +| :------ | :------ | :------ | :------ | +| `code` | [`RetryableOrderPurchaseScreenFailureCodeEnum`](../type-aliases/RetryableOrderPurchaseScreenFailureCodeEnum.md) | - | models/RetryableOrderPurchaseScreenFailure.ts:61 | +| `message` | `string` | - | models/RetryableOrderPurchaseScreenFailure.ts:62 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/RetryableOrderPurchaseUpdateFailureProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/RetryableOrderPurchaseUpdateFailureProperties.md new file mode 100644 index 00000000..aa1d12a2 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/RetryableOrderPurchaseUpdateFailureProperties.md @@ -0,0 +1,10 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > RetryableOrderPurchaseUpdateFailureProperties + +# Interface: RetryableOrderPurchaseUpdateFailureProperties + +## Properties + +| Property | Type | Description | Source | +| :------ | :------ | :------ | :------ | +| `code` | [`RetryableOrderPurchaseUpdateFailureCodeEnum`](../type-aliases/RetryableOrderPurchaseUpdateFailureCodeEnum.md) | - | models/RetryableOrderPurchaseUpdateFailure.ts:61 | +| `message` | `string` | - | models/RetryableOrderPurchaseUpdateFailure.ts:62 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/ServiceUnavailableErrorProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/ServiceUnavailableErrorProperties.md new file mode 100644 index 00000000..4d8e2e9b --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/ServiceUnavailableErrorProperties.md @@ -0,0 +1,10 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > ServiceUnavailableErrorProperties + +# Interface: ServiceUnavailableErrorProperties + +## Properties + +| Property | Type | Description | Source | +| :------ | :------ | :------ | :------ | +| `code` | [`ServiceUnavailableErrorCodeEnum`](../type-aliases/ServiceUnavailableErrorCodeEnum.md) | - | models/ServiceUnavailableError.ts:61 | +| `message` | `string` | - | models/ServiceUnavailableError.ts:62 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/SettledRefundUpdateDetailsProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/SettledRefundUpdateDetailsProperties.md new file mode 100644 index 00000000..9971a80e --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/SettledRefundUpdateDetailsProperties.md @@ -0,0 +1,13 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > SettledRefundUpdateDetailsProperties + +# Interface: SettledRefundUpdateDetailsProperties + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/SettledRefundUpdateProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/SettledRefundUpdateProperties.md new file mode 100644 index 00000000..29712533 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/SettledRefundUpdateProperties.md @@ -0,0 +1,14 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > SettledRefundUpdateProperties + +# Interface: SettledRefundUpdateProperties + +## Extends + +- [`RefundUpdateProperties`](RefundUpdateProperties.md) + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/SiteInfoProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/SiteInfoProperties.md new file mode 100644 index 00000000..2e6918aa --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/SiteInfoProperties.md @@ -0,0 +1,10 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > SiteInfoProperties + +# Interface: SiteInfoProperties + +## Properties + +| Property | Type | Description | Source | +| :------ | :------ | :------ | :------ | +| `agentAssisted` | `boolean` | - | models/SiteInfo.ts:44 | +| `countryCode` | `string` | - | models/SiteInfo.ts:43 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/TelephoneProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/TelephoneProperties.md new file mode 100644 index 00000000..f5647bc0 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/TelephoneProperties.md @@ -0,0 +1,17 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > TelephoneProperties + +# Interface: TelephoneProperties + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/TooManyRequestsErrorProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/TooManyRequestsErrorProperties.md new file mode 100644 index 00000000..cd31020a --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/TooManyRequestsErrorProperties.md @@ -0,0 +1,10 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > TooManyRequestsErrorProperties + +# Interface: TooManyRequestsErrorProperties + +## Properties + +| Property | Type | Description | Source | +| :------ | :------ | :------ | :------ | +| `code` | [`TooManyRequestsErrorCodeEnum`](../type-aliases/TooManyRequestsErrorCodeEnum.md) | - | models/TooManyRequestsError.ts:59 | +| `message` | `string` | - | models/TooManyRequestsError.ts:60 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/TransactionDetailsProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/TransactionDetailsProperties.md new file mode 100644 index 00000000..d6dd5d6d --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/TransactionDetailsProperties.md @@ -0,0 +1,14 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > TransactionDetailsProperties + +# Interface: TransactionDetailsProperties + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/TravelProductProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/TravelProductProperties.md new file mode 100644 index 00000000..7b7c8655 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/TravelProductProperties.md @@ -0,0 +1,22 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > TravelProductProperties + +# Interface: TravelProductProperties + +## Extended By + +- [`AirProperties`](AirProperties.md) +- [`CarProperties`](CarProperties.md) +- [`CruiseProperties`](CruiseProperties.md) +- [`HotelProperties`](HotelProperties.md) +- [`InsuranceProperties`](InsuranceProperties.md) +- [`RailProperties`](RailProperties.md) + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/TravelerProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/TravelerProperties.md new file mode 100644 index 00000000..999cacd1 --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/TravelerProperties.md @@ -0,0 +1,16 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > TravelerProperties + +# Interface: TravelerProperties + +## 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 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/UnauthorizedErrorProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/UnauthorizedErrorProperties.md new file mode 100644 index 00000000..16d1a7ed --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/UnauthorizedErrorProperties.md @@ -0,0 +1,10 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > UnauthorizedErrorProperties + +# Interface: UnauthorizedErrorProperties + +## Properties + +| Property | Type | Description | Source | +| :------ | :------ | :------ | :------ | +| `code` | [`UnauthorizedErrorCodeEnum`](../type-aliases/UnauthorizedErrorCodeEnum.md) | - | models/UnauthorizedError.ts:59 | +| `message` | `string` | - | models/UnauthorizedError.ts:60 | diff --git a/release/fraudPreventionV2/src/docs/models/interfaces/VerifyProperties.md b/release/fraudPreventionV2/src/docs/models/interfaces/VerifyProperties.md new file mode 100644 index 00000000..8c05c6ec --- /dev/null +++ b/release/fraudPreventionV2/src/docs/models/interfaces/VerifyProperties.md @@ -0,0 +1,12 @@ +[@expediagroup/fraudpreventionv2-sdk](../../index.md) > [models](../index.md) > VerifyProperties + +# Interface: VerifyProperties + +## 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 | diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.AccountTakeoverBadRequestErrorAllOfCausesCodeEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/AccountTakeoverBadRequestErrorAllOfCausesCodeEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.AccountTakeoverBadRequestErrorAllOfCausesCodeEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/AccountTakeoverBadRequestErrorAllOfCausesCodeEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.AccountTakeoverBadRequestErrorCodeEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/AccountTakeoverBadRequestErrorCodeEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.AccountTakeoverBadRequestErrorCodeEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/AccountTakeoverBadRequestErrorCodeEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.AccountTakeoverCustomerAccountAccountRoleEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/AccountTakeoverCustomerAccountAccountRoleEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.AccountTakeoverCustomerAccountAccountRoleEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/AccountTakeoverCustomerAccountAccountRoleEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.AccountTakeoverCustomerAccountAccountTypeEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/AccountTakeoverCustomerAccountAccountTypeEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.AccountTakeoverCustomerAccountAccountTypeEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/AccountTakeoverCustomerAccountAccountTypeEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.AccountTakeoverDeviceDetailsTypeEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/AccountTakeoverDeviceDetailsTypeEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.AccountTakeoverDeviceDetailsTypeEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/AccountTakeoverDeviceDetailsTypeEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.AccountTakeoverErrorCodeEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/AccountTakeoverErrorCodeEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.AccountTakeoverErrorCodeEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/AccountTakeoverErrorCodeEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.AccountTakeoverFraudDecision.md b/release/fraudPreventionV2/src/docs/models/type-aliases/AccountTakeoverFraudDecision.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.AccountTakeoverFraudDecision.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/AccountTakeoverFraudDecision.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.AccountTakeoverSiteInfoPlacementNameEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/AccountTakeoverSiteInfoPlacementNameEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.AccountTakeoverSiteInfoPlacementNameEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/AccountTakeoverSiteInfoPlacementNameEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.AccountTakeoverTransactionDetailsTypeEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/AccountTakeoverTransactionDetailsTypeEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.AccountTakeoverTransactionDetailsTypeEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/AccountTakeoverTransactionDetailsTypeEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.AccountTakeoverUnauthorizedErrorCodeEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/AccountTakeoverUnauthorizedErrorCodeEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.AccountTakeoverUnauthorizedErrorCodeEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/AccountTakeoverUnauthorizedErrorCodeEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.AccountUpdateNotFoundErrorCodeEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/AccountUpdateNotFoundErrorCodeEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.AccountUpdateNotFoundErrorCodeEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/AccountUpdateNotFoundErrorCodeEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.AccountUpdateRequestTypeEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/AccountUpdateRequestTypeEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.AccountUpdateRequestTypeEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/AccountUpdateRequestTypeEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.AddressAddressTypeEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/AddressAddressTypeEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.AddressAddressTypeEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/AddressAddressTypeEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.AirFlightTypeEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/AirFlightTypeEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.AirFlightTypeEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/AirFlightTypeEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.BadGatewayErrorCodeEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/BadGatewayErrorCodeEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.BadGatewayErrorCodeEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/BadGatewayErrorCodeEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.BadRequestErrorAllOfCausesCodeEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/BadRequestErrorAllOfCausesCodeEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.BadRequestErrorAllOfCausesCodeEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/BadRequestErrorAllOfCausesCodeEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.BadRequestErrorCodeEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/BadRequestErrorCodeEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.BadRequestErrorCodeEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/BadRequestErrorCodeEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.ChallengeDetailStatusEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/ChallengeDetailStatusEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.ChallengeDetailStatusEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/ChallengeDetailStatusEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.ChallengeDetailTypeEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/ChallengeDetailTypeEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.ChallengeDetailTypeEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/ChallengeDetailTypeEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.ChargebackDetailChargebackReasonEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/ChargebackDetailChargebackReasonEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.ChargebackDetailChargebackReasonEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/ChargebackDetailChargebackReasonEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.ChargebackDetailChargebackStatusEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/ChargebackDetailChargebackStatusEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.ChargebackDetailChargebackStatusEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/ChargebackDetailChargebackStatusEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.CreditCardCardTypeEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/CreditCardCardTypeEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.CreditCardCardTypeEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/CreditCardCardTypeEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.CustomerAccountAccountTypeEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/CustomerAccountAccountTypeEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.CustomerAccountAccountTypeEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/CustomerAccountAccountTypeEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.CustomerAccountAddressAddressTypeEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/CustomerAccountAddressAddressTypeEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.CustomerAccountAddressAddressTypeEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/CustomerAccountAddressAddressTypeEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.ForbiddenErrorCodeEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/ForbiddenErrorCodeEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.ForbiddenErrorCodeEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/ForbiddenErrorCodeEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.FraudDecision.md b/release/fraudPreventionV2/src/docs/models/type-aliases/FraudDecision.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.FraudDecision.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/FraudDecision.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.GatewayTimeoutErrorCodeEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/GatewayTimeoutErrorCodeEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.GatewayTimeoutErrorCodeEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/GatewayTimeoutErrorCodeEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.HotelAddressAddressTypeEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/HotelAddressAddressTypeEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.HotelAddressAddressTypeEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/HotelAddressAddressTypeEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.InternalServerErrorCodeEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/InternalServerErrorCodeEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.InternalServerErrorCodeEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/InternalServerErrorCodeEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.LoginTransactionDetailsAuthenticationSubTypeEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/LoginTransactionDetailsAuthenticationSubTypeEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.LoginTransactionDetailsAuthenticationSubTypeEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/LoginTransactionDetailsAuthenticationSubTypeEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.LoginTransactionDetailsAuthenticationTypeEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/LoginTransactionDetailsAuthenticationTypeEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.LoginTransactionDetailsAuthenticationTypeEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/LoginTransactionDetailsAuthenticationTypeEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.LoginTransactionDetailsFailedLoginReasonEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/LoginTransactionDetailsFailedLoginReasonEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.LoginTransactionDetailsFailedLoginReasonEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/LoginTransactionDetailsFailedLoginReasonEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.ModelErrorCodeEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/ModelErrorCodeEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.ModelErrorCodeEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/ModelErrorCodeEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.MultiFactorAuthenticationAttemptDeliveryMethodEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/MultiFactorAuthenticationAttemptDeliveryMethodEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.MultiFactorAuthenticationAttemptDeliveryMethodEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/MultiFactorAuthenticationAttemptDeliveryMethodEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.MultiFactorAuthenticationAttemptStatusEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/MultiFactorAuthenticationAttemptStatusEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.MultiFactorAuthenticationAttemptStatusEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/MultiFactorAuthenticationAttemptStatusEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.NotFoundErrorCodeEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/NotFoundErrorCodeEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.NotFoundErrorCodeEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/NotFoundErrorCodeEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.OrderPurchaseUpdateNotFoundErrorCodeEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/OrderPurchaseUpdateNotFoundErrorCodeEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.OrderPurchaseUpdateNotFoundErrorCodeEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/OrderPurchaseUpdateNotFoundErrorCodeEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.PaymentBillingAddressAddressTypeEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/PaymentBillingAddressAddressTypeEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.PaymentBillingAddressAddressTypeEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/PaymentBillingAddressAddressTypeEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.PaymentBrandEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/PaymentBrandEnum.md similarity index 79% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.PaymentBrandEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/PaymentBrandEnum.md index 7f96360a..7ce0ce70 100644 --- a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.PaymentBrandEnum.md +++ b/release/fraudPreventionV2/src/docs/models/type-aliases/PaymentBrandEnum.md @@ -2,7 +2,7 @@ # Type alias: PaymentBrandEnum -> **PaymentBrandEnum**: `"AMERICAN_EXPRESS"` \| `"DINERS_CLUB_INTERNATIONAL"` \| `"BC_CARD"` \| `"DISCOVER"` \| `"JCB"` \| `"MASTER_CARD"` \| `"MAESTRO"` \| `"POSTEPAY_MASTERCARD"` \| `"SOLO"` \| `"SWITCH"` \| `"CHINA_UNION_PAY"` \| `"VISA"` \| `"VISA_DELTA"` \| `"VISA_ELECTRON"` \| `"CARTA_SI"` \| `"CARTE_BLEUE"` \| `"VISA_DANKORT"` \| `"POSTEPAY_VISA_ELECTRON"` \| `"PAYPAL"` \| `"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"` \| `"GIFT_CARD"` \| `"IBP"` \| `"LOCAL_DEBIT_CARD"` \| `"SOFORT"` \| `"YANDEX"` \| `"WEB_MONEY"` \| `"QIWI"` \| `"BITCOIN"` \| `"ELV"` \| `"INTER_COMPANY"` +> **PaymentBrandEnum**: `"AMERICAN_EXPRESS"` \| `"DINERS_CLUB_INTERNATIONAL"` \| `"BC_CARD"` \| `"DISCOVER"` \| `"JCB"` \| `"MASTER_CARD"` \| `"MAESTRO"` \| `"POSTEPAY_MASTERCARD"` \| `"SOLO"` \| `"SWITCH"` \| `"CHINA_UNION_PAY"` \| `"VISA"` \| `"VISA_DELTA"` \| `"VISA_ELECTRON"` \| `"CARTA_SI"` \| `"CARTE_BLEUE"` \| `"VISA_DANKORT"` \| `"POSTEPAY_VISA_ELECTRON"` \| `"PAYPAL"` \| `"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"` \| `"UATP"` \| `"UATP_SUPPLY"` \| `"AIR_PLUS"` \| `"US_PASS_PLUS"` \| `"GIFT_CARD"` \| `"IBP"` \| `"LOCAL_DEBIT_CARD"` \| `"SOFORT"` \| `"YANDEX"` \| `"WEB_MONEY"` \| `"QIWI"` \| `"BITCOIN"` \| `"ELV"` \| `"INTER_COMPANY"` ## Source diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.PaymentMethod.md b/release/fraudPreventionV2/src/docs/models/type-aliases/PaymentMethod.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.PaymentMethod.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/PaymentMethod.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.PaymentReason.md b/release/fraudPreventionV2/src/docs/models/type-aliases/PaymentReason.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.PaymentReason.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/PaymentReason.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.PaymentStatus.md b/release/fraudPreventionV2/src/docs/models/type-aliases/PaymentStatus.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.PaymentStatus.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/PaymentStatus.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.RailRouteTypeEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/RailRouteTypeEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.RailRouteTypeEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/RailRouteTypeEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.RailSegmentsTransportationMethodEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/RailSegmentsTransportationMethodEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.RailSegmentsTransportationMethodEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/RailSegmentsTransportationMethodEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.RailwayStationDetailsTypeEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/RailwayStationDetailsTypeEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.RailwayStationDetailsTypeEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/RailwayStationDetailsTypeEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.RefundUpdateRefundStatusEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/RefundUpdateRefundStatusEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.RefundUpdateRefundStatusEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/RefundUpdateRefundStatusEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.RemediationUpdateActionActionNameEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/RemediationUpdateActionActionNameEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.RemediationUpdateActionActionNameEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/RemediationUpdateActionActionNameEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.RemediationUpdateActionStatusEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/RemediationUpdateActionStatusEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.RemediationUpdateActionStatusEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/RemediationUpdateActionStatusEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.RetryableOrderPurchaseScreenFailureCodeEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/RetryableOrderPurchaseScreenFailureCodeEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.RetryableOrderPurchaseScreenFailureCodeEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/RetryableOrderPurchaseScreenFailureCodeEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.RetryableOrderPurchaseUpdateFailureCodeEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/RetryableOrderPurchaseUpdateFailureCodeEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.RetryableOrderPurchaseUpdateFailureCodeEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/RetryableOrderPurchaseUpdateFailureCodeEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.ServiceUnavailableErrorCodeEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/ServiceUnavailableErrorCodeEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.ServiceUnavailableErrorCodeEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/ServiceUnavailableErrorCodeEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.Status.md b/release/fraudPreventionV2/src/docs/models/type-aliases/Status.md similarity index 66% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.Status.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/Status.md index cdd39b63..77c74989 100644 --- a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.Status.md +++ b/release/fraudPreventionV2/src/docs/models/type-aliases/Status.md @@ -4,7 +4,7 @@ > **Status**: `"COMPLETED"` \| `"CHANGE_COMPLETED"` \| `"CANCELLED"` \| `"FAILED"` \| `"CHANGE_FAILED"` -Defines the current state of the Order. Generally, OrderPurchaseScreenRequest is followed by an OrderUpdate reflecting the change in current order status. From `IN_PROGRESS` to any of below possible values: _ `COMPLETED` is used when the order has been processed fully. For example, inventory has been reserved, and the payment has been settled. _ `CHANGE_COMPLETED` is like `COMPLETED` but on a changed order. _ `CANCELLED` is used when the order is cancelled. This could be acustomer initiated cancel or based on Fraud recommendation. _ `FAILED` is used when order failed due to any errors on Partner system. This could be followed by another OrderUpdate call with any `order_status` once the order is recovered, abandoned, or cancelled. _ `CHANGE_FAILED` is like `FAILED` but on a changed order. _ _ `CHANGE_COMPLETED` or `CHANGE_FAILED` are applicable if OrderPurchaseScreen Fraud API was called via a change in order which is through `transaction.transaction_details.order_type` = `CHANGE` _ `COMPLETED` or `CANCELLED` order status indicates the completion of lifecycle on an order. +Defines the current state of the Order. Generally, OrderPurchaseScreenRequest is followed by an OrderUpdate reflecting the change in current order status. From `IN_PROGRESS` to any of below possible values: * `COMPLETED` is used when the order has been processed fully. For example, inventory has been reserved, and the payment has been settled. * `CHANGE_COMPLETED` is like `COMPLETED` but on a changed order. * `CANCELLED` is used when the order is cancelled. This could be acustomer initiated cancel or based on Fraud recommendation. * `FAILED` is used when order failed due to any errors on Partner system. This could be followed by another OrderUpdate call with any `order_status` once the order is recovered, abandoned, or cancelled. * `CHANGE_FAILED` is like `FAILED` but on a changed order. * * `CHANGE_COMPLETED` or `CHANGE_FAILED` are applicable if OrderPurchaseScreen Fraud API was called via a change in order which is through `transaction.transaction_details.order_type` = `CHANGE` * `COMPLETED` or `CANCELLED` order status indicates the completion of lifecycle on an order. ## Source diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.TelephonePlatformType.md b/release/fraudPreventionV2/src/docs/models/type-aliases/TelephonePlatformType.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.TelephonePlatformType.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/TelephonePlatformType.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.TelephoneType.md b/release/fraudPreventionV2/src/docs/models/type-aliases/TelephoneType.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.TelephoneType.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/TelephoneType.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.TooManyRequestsErrorCodeEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/TooManyRequestsErrorCodeEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.TooManyRequestsErrorCodeEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/TooManyRequestsErrorCodeEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.TransactionDetailsCurrentOrderStatusEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/TransactionDetailsCurrentOrderStatusEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.TransactionDetailsCurrentOrderStatusEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/TransactionDetailsCurrentOrderStatusEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.TransactionDetailsOrderTypeEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/TransactionDetailsOrderTypeEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.TransactionDetailsOrderTypeEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/TransactionDetailsOrderTypeEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.TravelProductInventorySourceEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/TravelProductInventorySourceEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.TravelProductInventorySourceEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/TravelProductInventorySourceEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.TravelProductType.md b/release/fraudPreventionV2/src/docs/models/type-aliases/TravelProductType.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.TravelProductType.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/TravelProductType.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.UnauthorizedErrorCodeEnum.md b/release/fraudPreventionV2/src/docs/models/type-aliases/UnauthorizedErrorCodeEnum.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.UnauthorizedErrorCodeEnum.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/UnauthorizedErrorCodeEnum.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.UpdateType.md b/release/fraudPreventionV2/src/docs/models/type-aliases/UpdateType.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.UpdateType.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/UpdateType.md diff --git a/release/fraudPreventionV2/docs/models/type-aliases/type-alias.VerificationType.md b/release/fraudPreventionV2/src/docs/models/type-aliases/VerificationType.md similarity index 100% rename from release/fraudPreventionV2/docs/models/type-aliases/type-alias.VerificationType.md rename to release/fraudPreventionV2/src/docs/models/type-aliases/VerificationType.md diff --git a/release/fraudPreventionV2/src/models/Hotel.ts b/release/fraudPreventionV2/src/models/Hotel.ts index f2b54a2a..e9a0ea70 100644 --- a/release/fraudPreventionV2/src/models/Hotel.ts +++ b/release/fraudPreventionV2/src/models/Hotel.ts @@ -17,10 +17,10 @@ * https://openapi-generator.tech * Do not edit the class manually. */ -import { HotelAllOfAddress } from './HotelAllOfAddress' +import { HotelAddress } from './HotelAddress' import { TravelProduct } from './TravelProduct' -import { HotelAllOfAddressMapper } from './HotelAllOfAddressMapper' +import { HotelAddressMapper } from './HotelAddressMapper' import { JsonObject, JsonProperty } from 'typescript-json-serializer' import { TravelProductProperties } from './TravelProduct' @@ -49,9 +49,9 @@ export class Hotel extends TravelProduct { roomCount?: number @JsonProperty({ name: 'address', - type: (property) => HotelAllOfAddressMapper.getType(property), + type: (property) => HotelAddressMapper.getType(property), }) - address: HotelAllOfAddress + address: HotelAddress /** * Local date and time of the hotel check-in, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. */ @@ -89,7 +89,7 @@ export interface HotelProperties extends TravelProductProperties { priceWithheld?: boolean hotelName: string roomCount?: number - address: HotelAllOfAddress + address: HotelAddress checkinTime: Date checkoutTime: Date } diff --git a/release/fraudPreventionV2/src/models/HotelAllOfAddress.ts b/release/fraudPreventionV2/src/models/HotelAllOfAddress.ts deleted file mode 100644 index 67b79e06..00000000 --- a/release/fraudPreventionV2/src/models/HotelAllOfAddress.ts +++ /dev/null @@ -1,79 +0,0 @@ -/* - * Copyright (C) 2023 Expedia, Inc. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -import { JsonObject, JsonProperty } from 'typescript-json-serializer' - -@JsonObject({ constructorParams: [{}] }) -export class HotelAllOfAddress { - @JsonProperty({ name: 'address_type' }) - addressType?: HotelAllOfAddressAddressTypeEnum - /** - * Address line 1 of the address provided. - */ - @JsonProperty({ name: 'address_line1' }) - addressLine1: string - /** - * Address line 2 of the address provided. - */ - @JsonProperty({ name: 'address_line2' }) - addressLine2?: string - /** - * City of the address provided. - */ - @JsonProperty({ name: 'city' }) - city: string - /** - * The two-characters ISO code for the state or province of the address. - */ - @JsonProperty({ name: 'state' }) - state: string - /** - * Zip code of the address provided. - */ - @JsonProperty({ name: 'zip_code' }) - zipCode: string - /** - * ISO alpha-3 country code of the address provided. - */ - @JsonProperty({ name: 'country_code' }) - countryCode: string - - public constructor(hotelAllOfAddress: HotelAllOfAddressProperties) { - this.addressType = hotelAllOfAddress.addressType - this.addressLine1 = hotelAllOfAddress.addressLine1 - this.addressLine2 = hotelAllOfAddress.addressLine2 - this.city = hotelAllOfAddress.city - this.state = hotelAllOfAddress.state - this.zipCode = hotelAllOfAddress.zipCode - this.countryCode = hotelAllOfAddress.countryCode - } -} - -export type HotelAllOfAddressAddressTypeEnum = 'HOME' | 'WORK' - -export interface HotelAllOfAddressProperties { - addressType?: HotelAllOfAddressAddressTypeEnum - addressLine1: string - addressLine2?: string - city: string - state: string - zipCode: string - countryCode: string -} diff --git a/release/fraudPreventionV2/src/models/HotelAllOfAddressMapper.ts b/release/fraudPreventionV2/src/models/HotelAllOfAddressMapper.ts deleted file mode 100644 index f869365d..00000000 --- a/release/fraudPreventionV2/src/models/HotelAllOfAddressMapper.ts +++ /dev/null @@ -1,26 +0,0 @@ -/* - * Copyright (C) 2023 Expedia, Inc. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ -import { HotelAllOfAddress } from './HotelAllOfAddress' - -export class HotelAllOfAddressMapper { - static getType(_) { - return HotelAllOfAddress - } -} diff --git a/release/fraudPreventionV2/src/models/Payment.ts b/release/fraudPreventionV2/src/models/Payment.ts index 45da3e30..72a72e66 100644 --- a/release/fraudPreventionV2/src/models/Payment.ts +++ b/release/fraudPreventionV2/src/models/Payment.ts @@ -42,7 +42,7 @@ import { JsonObject, JsonProperty } from 'typescript-json-serializer' @JsonObject({ constructorParams: [{}] }) export class Payment { /** - * The `brand` field value is the payment brand used for payment on this transaction. For credit card payment method ensure attributes mentioned in dictionary below are set to corresponding values only. Ensure to comply with the naming standards provided in below dictionary. For example, some Payment processors use “Japan Credit Bureau” but “JCB” should be used when calling Fraud API. Incorrect `brand` - `card_type` combination will result in data quality issues and result in degraded risk recommendation. \'brand\' is an enum value with the following mapping with CreditCard \'card_type\' attribute: * brand : card_type * ------------------------------------------------------- * `AMERICAN_EXPRESS` : `AMERICAN_EXPRESS` * `DINERS_CLUB_INTERNATIONAL` : `DINERS_CLUB` * `BC_CARD` : `DINERS_CLUB` * `DISCOVER` : `DISCOVER` * `BC_CARD` : `DISCOVER` * `DINERS_CLUB_INTERNATIONAL` : `DISCOVER` * `JCB` : `DISCOVER` * `JCB` : `JCB` * `MASTER_CARD` : `MASTER_CARD` * `MAESTRO` : `MASTER_CARD` * `POSTEPAY_MASTERCARD` : `MASTER_CARD` * `SOLO` : `SOLO` * `SWITCH` : `SWITCH` * `MAESTRO` : `MAESTRO` * `CHINA_UNION_PAY` : `CHINA_UNION_PAY` * `VISA` : `VISA` * `VISA_DELTA` : `VISA` * `VISA_ELECTRON` : `VISA` * `CARTA_SI` : `VISA` * `CARTE_BLEUE` : `VISA` * `VISA_DANKORT` : `VISA` * `POSTEPAY_VISA_ELECTRON` : `VISA` * `PAYPAL` : \'brand\' with \'Points\' payment_type is an enum value with following: * `EXPEDIA_REWARDS` * `AMEX_POINTS` * `BANK_OF_AMERICA_REWARDS` * `DISCOVER_POINTS` * `MASTER_CARD_POINTS` * `CITI_THANK_YOU_POINTS` * `MERRILL_LYNCH_REWARDS` * `WELLS_FARGO_POINTS` * `DELTA_SKY_MILES` * `UNITED_POINTS` * `DISCOVER_MILES` * `ALASKA_MILES` * `RBC_REWARDS` * `BILT_REWARDS` * `ORBUCKS` * `CHEAP_CASH` * `BONUS_PLUS` * `ULTIMATE_REWARDS` \'brand\' with \'GiftCard\' payment_type is an enum value with following: * `GIFT_CARD` \'brand\' with \'InternetBankPayment\' payment_type is an enum value with following: * `IBP` * `LOCAL_DEBIT_CARD` * `SOFORT` * `YANDEX` * `WEB_MONEY` * `QIWI` * `BITCOIN` \'brand\' with \'DirectDebit\' payment_type is an enum value with following: * `ELV` * `INTER_COMPANY` + * The `brand` field value is the payment brand used for payment on this transaction. For credit card payment method ensure attributes mentioned in dictionary below are set to corresponding values only. Ensure to comply with the naming standards provided in below dictionary. For example, some Payment processors use “Japan Credit Bureau” but “JCB” should be used when calling Fraud API. Incorrect `brand` - `card_type` combination will result in data quality issues and result in degraded risk recommendation. \'brand\' is an enum value with the following mapping with CreditCard \'card_type\' attribute: * brand : card_type * ------------------------------------------------------- * `AMERICAN_EXPRESS` : `AMERICAN_EXPRESS` * `DINERS_CLUB_INTERNATIONAL` : `DINERS_CLUB` * `BC_CARD` : `DINERS_CLUB` * `DISCOVER` : `DISCOVER` * `BC_CARD` : `DISCOVER` * `DINERS_CLUB_INTERNATIONAL` : `DISCOVER` * `JCB` : `DISCOVER` * `JCB` : `JCB` * `MASTER_CARD` : `MASTER_CARD` * `MAESTRO` : `MASTER_CARD` * `POSTEPAY_MASTERCARD` : `MASTER_CARD` * `SOLO` : `SOLO` * `SWITCH` : `SWITCH` * `MAESTRO` : `MAESTRO` * `CHINA_UNION_PAY` : `CHINA_UNION_PAY` * `VISA` : `VISA` * `VISA_DELTA` : `VISA` * `VISA_ELECTRON` : `VISA` * `CARTA_SI` : `VISA` * `CARTE_BLEUE` : `VISA` * `VISA_DANKORT` : `VISA` * `POSTEPAY_VISA_ELECTRON` : `VISA` * `PAYPAL` : \'brand\' with \'Points\' payment_type is an enum value with following: * `EXPEDIA_REWARDS` * `AMEX_POINTS` * `BANK_OF_AMERICA_REWARDS` * `DISCOVER_POINTS` * `MASTER_CARD_POINTS` * `CITI_THANK_YOU_POINTS` * `MERRILL_LYNCH_REWARDS` * `WELLS_FARGO_POINTS` * `DELTA_SKY_MILES` * `UNITED_POINTS` * `DISCOVER_MILES` * `ALASKA_MILES` * `RBC_REWARDS` * `BILT_REWARDS` * `ORBUCKS` * `CHEAP_CASH` * `BONUS_PLUS` * `ULTIMATE_REWARDS` * `UATP` * `UATP_SUPPLY` * `AIR_PLUS` * `US_PASS_PLUS` \'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` */ @JsonProperty({ name: 'brand' }) brand: PaymentBrandEnum @@ -135,6 +135,10 @@ export type PaymentBrandEnum = | 'CHEAP_CASH' | 'BONUS_PLUS' | 'ULTIMATE_REWARDS' + | 'UATP' + | 'UATP_SUPPLY' + | 'AIR_PLUS' + | 'US_PASS_PLUS' | 'GIFT_CARD' | 'IBP' | 'LOCAL_DEBIT_CARD' diff --git a/release/fraudPreventionV2/src/models/RailwayStationDetails.ts b/release/fraudPreventionV2/src/models/RailwayStationDetails.ts index b9ddfc9a..5370ab47 100644 --- a/release/fraudPreventionV2/src/models/RailwayStationDetails.ts +++ b/release/fraudPreventionV2/src/models/RailwayStationDetails.ts @@ -17,9 +17,9 @@ * https://openapi-generator.tech * Do not edit the class manually. */ -import { CustomerAccountAddress } from './CustomerAccountAddress' +import { Address } from './Address' -import { CustomerAccountAddressMapper } from './CustomerAccountAddressMapper' +import { AddressMapper } from './AddressMapper' import { JsonObject, JsonProperty } from 'typescript-json-serializer' @@ -42,9 +42,9 @@ export class RailwayStationDetails { stationCode: string @JsonProperty({ name: 'address', - type: (property) => CustomerAccountAddressMapper.getType(property), + type: (property) => AddressMapper.getType(property), }) - address: CustomerAccountAddress + address: Address /** * The timezone associated with the location of the station, specifying the local time offset from Coordinated Universal Time (UTC). */ @@ -66,6 +66,6 @@ export interface RailwayStationDetailsProperties { name: string type?: RailwayStationDetailsTypeEnum stationCode: string - address: CustomerAccountAddress + address: Address timezone?: string } diff --git a/release/fraudPreventionV2/src/models/index.ts b/release/fraudPreventionV2/src/models/index.ts index 84e65934..db0519f7 100644 --- a/release/fraudPreventionV2/src/models/index.ts +++ b/release/fraudPreventionV2/src/models/index.ts @@ -63,7 +63,6 @@ export * from './GatewayTimeoutError' export * from './GiftCard' export * from './Hotel' export * from './HotelAddress' -export * from './HotelAllOfAddress' export * from './InsultDetail' export * from './InsultFeedback' export * from './Insurance' diff --git a/release/fraudPreventionV2/src/package.json b/release/fraudPreventionV2/src/package.json index 63dfc8b9..0369c719 100644 --- a/release/fraudPreventionV2/src/package.json +++ b/release/fraudPreventionV2/src/package.json @@ -1,7 +1,7 @@ { "name": "@expediagroup/fraudpreventionv2-sdk", - "version": "2.2.0", - "description": "ExpediaGroup FraudPreventionV2 SDK v2.2.0 Core Modules of EG Travel SDK", + "version": "3.0.0", + "description": "ExpediaGroup FraudPreventionV2 SDK v3.0.0 Core Modules of EG Travel SDK", "main": "lib/index.js", "types": "index.ts", "scripts": { @@ -14,12 +14,12 @@ "test": "jest" }, "dependencies": { - "@types/node": "20.8.2", - "@types/uuid": "9.0.4", + "@types/node": "20.8.6", + "@types/uuid": "9.0.5", "axios": "1.5.1", "typescript-json-serializer": "6.0.1", "uuid": "9.0.1", - "winston": "^3.10.0" + "winston": "3.11.0" }, "devDependencies": { "@babel/preset-env": "7.22.20", @@ -31,8 +31,8 @@ "prettier-plugin-organize-imports": "3.2.3", "ts-jest": "29.1.1", "ts-standard": "12.0.2", - "typedoc": "0.25.1", - "typedoc-plugin-markdown": "4.0.0-next.22", + "typedoc": "0.25.2", + "typedoc-plugin-markdown": "4.0.0-next.23", "typedoc-plugin-missing-exports": "2.1.0", "typescript": "5.2.2" }, diff --git a/release/fraudPreventionV2/src/specs.yaml b/release/fraudPreventionV2/src/specs.yaml index 22149310..da3acec8 100644 --- a/release/fraudPreventionV2/src/specs.yaml +++ b/release/fraudPreventionV2/src/specs.yaml @@ -29,7 +29,7 @@ paths: operationId: screenOrder security: - orderPurchaseScreenAuth: - - fraudandrisk.stub.order-purchase-screen + - fraudandrisk.fraud.order-purchase-screen requestBody: required: true content: @@ -114,7 +114,7 @@ paths: operationId: notifyWithOrderUpdate security: - orderPurchaseUpdateAuth: - - fraudandrisk.stub.order-purchase-update + - fraudandrisk.fraud.order-purchase-update requestBody: required: true description: > @@ -245,7 +245,7 @@ paths: operationId: screenAccount security: - accountScreenAuth: - - fraudandrisk.stub.account-screen + - fraudandrisk.fraud.account-screen requestBody: required: true content: @@ -328,7 +328,7 @@ paths: operationId: notifyWithAccountUpdate security: - accountUpdateAuth: - - fraudandrisk.stub.account-update + - fraudandrisk.fraud.account-update requestBody: required: true description: An AccountUpdate request may be of one of the following types @@ -1482,14 +1482,7 @@ components: maxLength: 200 example: GCT address: - allOf: - - $ref: "#/components/schemas/Address" - - required: - - address_line1 - - city - - state - - zip_code - - country_code + $ref: "#/components/schemas/Address" timezone: description: The timezone associated with the location of the station, specifying the local time offset from Coordinated Universal Time @@ -1676,14 +1669,7 @@ components: type: integer format: int32 address: - allOf: - - $ref: "#/components/schemas/HotelAddress" - - required: - - address_line1 - - city - - state - - zip_code - - country_code + $ref: "#/components/schemas/HotelAddress" checkin_time: description: Local date and time of the hotel check-in, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. @@ -1842,6 +1828,14 @@ components: * `ULTIMATE_REWARDS` + * `UATP` + + * `UATP_SUPPLY` + + * `AIR_PLUS` + + * `US_PASS_PLUS` + 'brand' with 'GiftCard' payment_type is an enum value with following: @@ -1909,6 +1903,10 @@ components: - CHEAP_CASH - BONUS_PLUS - ULTIMATE_REWARDS + - UATP + - UATP_SUPPLY + - AIR_PLUS + - US_PASS_PLUS - GIFT_CARD - IBP - LOCAL_DEBIT_CARD @@ -3278,11 +3276,11 @@ components: clientCredentials: tokenUrl: https://api.expediagroup.com/identity/oauth2/v3/token?grant_type=client_credentials scopes: - fraudandrisk.stub.order-purchase-screen: Use Fraud Systems for screening orders + fraudandrisk.fraud.order-purchase-screen: Use Fraud Systems for screening orders orderPurchaseUpdateAuth: type: oauth2 flows: clientCredentials: tokenUrl: https://api.expediagroup.com/identity/oauth2/v3/token?grant_type=client_credentials scopes: - fraudandrisk.stub.order-purchase-update: Use Fraud Systems for updating orders + fraudandrisk.fraud.order-purchase-update: Use Fraud Systems for updating orders