chore: Publish fraudPreventionV2 [4.4.0] SDK (#212)

release/fraudPreventionV2/docs/client/classes/FraudPreventionV2Client.md

@@ -4,7 +4,7 @@
 
 ## Extends
 
-- [`Client`](../../models/core/classes/Client.md)
+- [`Client`](../core/classes/Client.md)
 
 ## Constructors
 
@@ -14,15 +14,15 @@
 
 #### Parameters
 
-▪ **configurations**: [`ClientConfigurations`](../../models/core/interfaces/ClientConfigurations.md)
+• **configurations**: [`ClientConfigurations`](../core/interfaces/ClientConfigurations.md)
 
 #### Returns
 
 [`FraudPreventionV2Client`](FraudPreventionV2Client.md)
 
 #### Overrides
 
-Client.constructor
+`Client.constructor`
 
 #### Source
 
@@ -39,13 +39,13 @@ The Account Update API is called when there is an account lifecycle transition s
 
 #### Parameters
 
-▪ **accountUpdateRequest**: [`AccountUpdateRequest`](../../models/classes/AccountUpdateRequest.md)
+• **accountUpdateRequest**: [`AccountUpdateRequest`](../../models/classes/AccountUpdateRequest.md)
 
 An AccountUpdate request may be of one of the following types `MULTI_FACTOR_AUTHENTICATION_UPDATE`, `REMEDIATION_UPDATE`.
 
-▪ **transactionId**: `string`= `undefined`
+• **transactionId**: `string`= `undefined`
 
-A unique ID to uniquely identify a request/response cycle (optional, defaults to a random generated UUID)`<AccountUpdateResponse>` 
+A unique ID to uniquely identify a request/response cycle (optional, defaults to a random generated UUID)`<AccountUpdateResponse>`
 
 #### Returns
 
@@ -104,13 +104,13 @@ The Order Purchase Update API is called when the status of the order has changed
 
 #### Parameters
 
-▪ **orderPurchaseUpdateRequest**: [`OrderPurchaseUpdateRequest`](../../models/classes/OrderPurchaseUpdateRequest.md)
+• **orderPurchaseUpdateRequest**: [`OrderPurchaseUpdateRequest`](../../models/classes/OrderPurchaseUpdateRequest.md)
 
 An OrderPurchaseUpdate request may be of one of the following types &#x60;ORDER_UPDATE&#x60;, &#x60;CHARGEBACK_FEEDBACK&#x60;, &#x60;INSULT_FEEDBACK&#x60;, &#x60;REFUND_UPDATE&#x60;, &#x60;PAYMENT_UPDATE&#x60;.
 
-▪ **transactionId**: `string`= `undefined`
+• **transactionId**: `string`= `undefined`
 
-A unique ID to uniquely identify a request/response cycle (optional, defaults to a random generated UUID)`<OrderPurchaseUpdateResponse>` 
+A unique ID to uniquely identify a request/response cycle (optional, defaults to a random generated UUID)`<OrderPurchaseUpdateResponse>`
 
 #### Returns
 
@@ -169,11 +169,11 @@ The Account Screen API gives a Fraud recommendation for an account transaction.
 
 #### Parameters
 
-▪ **accountScreenRequest**: [`AccountScreenRequest`](../../models/classes/AccountScreenRequest.md)
+• **accountScreenRequest**: [`AccountScreenRequest`](../../models/classes/AccountScreenRequest.md)
 
-▪ **transactionId**: `string`= `undefined`
+• **transactionId**: `string`= `undefined`
 
-A unique ID to uniquely identify a request/response cycle (optional, defaults to a random generated UUID)`<AccountScreenResponse>` 
+A unique ID to uniquely identify a request/response cycle (optional, defaults to a random generated UUID)`<AccountScreenResponse>`
 
 #### Returns
 
@@ -232,11 +232,11 @@ The Order Purchase API gives a Fraud recommendation for a transaction. A recomme
 
 #### Parameters
 
-▪ **orderPurchaseScreenRequest**: [`OrderPurchaseScreenRequest`](../../models/classes/OrderPurchaseScreenRequest.md)
+• **orderPurchaseScreenRequest**: [`OrderPurchaseScreenRequest`](../../models/classes/OrderPurchaseScreenRequest.md)
 
-▪ **transactionId**: `string`= `undefined`
+• **transactionId**: `string`= `undefined`
 
-A unique ID to uniquely identify a request/response cycle (optional, defaults to a random generated UUID)`<OrderPurchaseScreenResponse>` 
+A unique ID to uniquely identify a request/response cycle (optional, defaults to a random generated UUID)`<OrderPurchaseScreenResponse>`
 
 #### Returns
 

release/fraudPreventionV2/docs/client/core/classes/AxiosClientConfigurations.md

@@ -0,0 +1,30 @@
+[@expediagroup/fraudpreventionv2-sdk](../../../index.md) / [client](../../index.md) / [core](../index.md) / AxiosClientConfigurations
+
+# Class: AxiosClientConfigurations
+
+## Constructors
+
+### new AxiosClientConfigurations(endpoint, requestTimeout)
+
+> **new AxiosClientConfigurations**(`endpoint`, `requestTimeout`): [`AxiosClientConfigurations`](AxiosClientConfigurations.md)
+
+#### Parameters
+
+• **endpoint**: `string`= `Constant.ENDPOINT`
+
+• **requestTimeout**: `number`= `Constant.TEN_SECONDS_IN_MILLIS`
+
+#### Returns
+
+[`AxiosClientConfigurations`](AxiosClientConfigurations.md)
+
+#### Source
+
+core/src/client/AxiosClientConfigurations.ts:24
+
+## Properties
+
+| Property | Modifier | Type |
+| :------ | :------ | :------ |
+| `endpoint` | `readonly` | `string` |
+| `requestTimeout` | `readonly` | `number` |

release/fraudPreventionV2/docs/client/core/classes/Client.md

@@ -0,0 +1,7 @@
+[@expediagroup/fraudpreventionv2-sdk](../../../index.md) / [client](../../index.md) / [core](../index.md) / Client
+
+# Class: `abstract` Client
+
+## Extended by
+
+- [`FraudPreventionV2Client`](../../classes/FraudPreventionV2Client.md)

release/fraudPreventionV2/docs/models/core/index.md → release/fraudPreventionV2/docs/client/core/index.md

@@ -1,4 +1,4 @@
-[@expediagroup/fraudpreventionv2-sdk](../../index.md) / [models](../index.md) / core
+[@expediagroup/fraudpreventionv2-sdk](../../index.md) / [client](../index.md) / core
 
 # core
 

release/fraudPreventionV2/docs/client/core/interfaces/ClientConfigurations.md

@@ -0,0 +1,13 @@
+[@expediagroup/fraudpreventionv2-sdk](../../../index.md) / [client](../../index.md) / [core](../index.md) / ClientConfigurations
+
+# Interface: ClientConfigurations
+
+## Properties
+
+| Property | Type |
+| :------ | :------ |
+| `authEndpoint?` | `string` |
+| `endpoint?` | `string` |
+| `key` | `string` |
+| `requestTimeout?` | `number` |
+| `secret` | `string` |

release/fraudPreventionV2/docs/client/index.md

@@ -4,6 +4,10 @@
 
 ## Index
 
+### Modules
+
+- [core](core/index.md)
+
 ### Classes
 
 - [FraudPreventionV2Client](classes/FraudPreventionV2Client.md)

release/fraudPreventionV2/docs/models/classes/AccountScreenRequest.md

@@ -12,7 +12,7 @@ Information for account screening by Expedia\'s Fraud Prevention Service.
 
 #### Parameters
 
-▪ **accountScreenRequest**: [`AccountScreenRequestProperties`](../interfaces/AccountScreenRequestProperties.md)
+• **accountScreenRequest**: [`AccountScreenRequestProperties`](../interfaces/AccountScreenRequestProperties.md)
 
 #### Returns
 
@@ -24,6 +24,6 @@ models/AccountScreenRequest.ts:36
 
 ## Properties
 
-| Property | Type | Description | Source |
-| :------ | :------ | :------ | :------ |
-| `transaction` | [`AccountTransaction`](AccountTransaction.md) | - | models/AccountScreenRequest.ts:34 |
+| Property | Type |
+| :------ | :------ |
+| `transaction` | [`AccountTransaction`](AccountTransaction.md) |

release/fraudPreventionV2/docs/models/classes/AccountScreenResponse.md

@@ -12,7 +12,7 @@ Response for an account transaction provided by Expedia\'s Fraud Prevention Serv
 
 #### Parameters
 
-▪ **accountScreenResponse**: [`AccountScreenResponseProperties`](../interfaces/AccountScreenResponseProperties.md)
+• **accountScreenResponse**: [`AccountScreenResponseProperties`](../interfaces/AccountScreenResponseProperties.md)
 
 #### Returns
 
@@ -24,7 +24,7 @@ models/AccountScreenResponse.ts:37
 
 ## Properties
 
-| Property | Type | Description | Source |
-| :------ | :------ | :------ | :------ |
-| `decision`? | [`AccountTakeoverFraudDecision`](../type-aliases/AccountTakeoverFraudDecision.md) | - | models/AccountScreenResponse.ts:35 |
-| `riskId`? | `string` | Unique identifier assigned to the transaction by Expedia\'s Fraud Prevention Service. | models/AccountScreenResponse.ts:33 |
+| Property | Type | Description |
+| :------ | :------ | :------ |
+| `decision?` | [`AccountTakeoverFraudDecision`](../type-aliases/AccountTakeoverFraudDecision.md) | - |
+| `riskId?` | `string` | Unique identifier assigned to the transaction by Expedia\'s Fraud Prevention Service. |

release/fraudPreventionV2/docs/models/classes/AccountTakeoverBadRequestError.md

@@ -12,7 +12,7 @@ Indicates that a bad request occurred. Typically it is an invalid parameter.
 
 #### Parameters
 
-▪ **accountTakeoverBadRequestError**: [`AccountTakeoverBadRequestErrorProperties`](../interfaces/AccountTakeoverBadRequestErrorProperties.md)
+• **accountTakeoverBadRequestError**: [`AccountTakeoverBadRequestErrorProperties`](../interfaces/AccountTakeoverBadRequestErrorProperties.md)
 
 #### Returns
 
@@ -24,8 +24,8 @@ models/AccountTakeoverBadRequestError.ts:48
 
 ## Properties
 
-| Property | Type | Description | Source |
-| :------ | :------ | :------ | :------ |
-| `causes`? | [`AccountTakeoverBadRequestErrorAllOfCauses`](AccountTakeoverBadRequestErrorAllOfCauses.md)[] | - | models/AccountTakeoverBadRequestError.ts:46 |
-| `code` | [`AccountTakeoverBadRequestErrorCodeEnum`](../type-aliases/AccountTakeoverBadRequestErrorCodeEnum.md) | Snake cased all caps error code interpreted from the HTTP status code that can programmatically be acted upon. | models/AccountTakeoverBadRequestError.ts:35 |
-| `message` | `string` | A human-readable explanation of the error, specific to this error occurrence. | models/AccountTakeoverBadRequestError.ts:40 |
+| Property | Type | Description |
+| :------ | :------ | :------ |
+| `causes?` | [`AccountTakeoverBadRequestErrorAllOfCauses`](AccountTakeoverBadRequestErrorAllOfCauses.md)[] | - |
+| `code` | [`AccountTakeoverBadRequestErrorCodeEnum`](../type-aliases/AccountTakeoverBadRequestErrorCodeEnum.md) | Snake cased all caps error code interpreted from the HTTP status code that can programmatically be acted upon. |
+| `message` | `string` | A human-readable explanation of the error, specific to this error occurrence. |

release/fraudPreventionV2/docs/models/classes/AccountTakeoverBadRequestErrorAllOfCauses.md

@@ -10,7 +10,7 @@
 
 #### Parameters
 
-▪ **accountTakeoverBadRequestErrorAllOfCauses**: [`AccountTakeoverBadRequestErrorAllOfCausesProperties`](../interfaces/AccountTakeoverBadRequestErrorAllOfCausesProperties.md)
+• **accountTakeoverBadRequestErrorAllOfCauses**: [`AccountTakeoverBadRequestErrorAllOfCausesProperties`](../interfaces/AccountTakeoverBadRequestErrorAllOfCausesProperties.md)
 
 #### Returns
 
@@ -22,8 +22,8 @@ models/AccountTakeoverBadRequestErrorAllOfCauses.ts:35
 
 ## Properties
 
-| Property | Type | Description | Source |
-| :------ | :------ | :------ | :------ |
-| `code`? | [`AccountTakeoverBadRequestErrorAllOfCausesCodeEnum`](../type-aliases/AccountTakeoverBadRequestErrorAllOfCausesCodeEnum.md) | - | models/AccountTakeoverBadRequestErrorAllOfCauses.ts:26 |
-| `field`? | `string` | A JSON Path expression indicating which field, in the request body, caused the error. | models/AccountTakeoverBadRequestErrorAllOfCauses.ts:31 |
-| `message`? | `string` | - | models/AccountTakeoverBadRequestErrorAllOfCauses.ts:33 |
+| Property | Type | Description |
+| :------ | :------ | :------ |
+| `code?` | [`AccountTakeoverBadRequestErrorAllOfCausesCodeEnum`](../type-aliases/AccountTakeoverBadRequestErrorAllOfCausesCodeEnum.md) | - |
+| `field?` | `string` | A JSON Path expression indicating which field, in the request body, caused the error. |
+| `message?` | `string` | - |

release/fraudPreventionV2/docs/models/classes/AccountTakeoverCustomerAccount.md

@@ -12,7 +12,7 @@ Information about a user\'s account.
 
 #### Parameters
 
-▪ **accountTakeoverCustomerAccount**: [`AccountTakeoverCustomerAccountProperties`](../interfaces/AccountTakeoverCustomerAccountProperties.md)
+• **accountTakeoverCustomerAccount**: [`AccountTakeoverCustomerAccountProperties`](../interfaces/AccountTakeoverCustomerAccountProperties.md)
 
 #### Returns
 
@@ -24,16 +24,16 @@ models/AccountTakeoverCustomerAccount.ts:93
 
 ## Properties
 
-| Property | Type | Description | Source |
-| :------ | :------ | :------ | :------ |
-| `accountRole`? | [`AccountTakeoverCustomerAccountAccountRoleEnum`](../type-aliases/AccountTakeoverCustomerAccountAccountRoleEnum.md) | Identifies the account role and associated permissions of a user\'\'s account. Possible values are: - `USER`: Basic account with no special privileges. - `MANAGER`: Account with additional privileges, such as the ability to make bookings for others. - `ADMIN`: Account with higher privileges than a manager, including the ability to grant manager access to other users. | models/AccountTakeoverCustomerAccount.ts:51 |
-| `accountType` | [`AccountTakeoverCustomerAccountAccountTypeEnum`](../type-aliases/AccountTakeoverCustomerAccountAccountTypeEnum.md) | Identifies the account type of a user\'\'s account. Possible values are: - `INDIVIDUAL` - Applicable if this account is for an individual traveler. - `BUSINESS` - Applicable if this account is for a business or organization account used by suppliers or Partners. | models/AccountTakeoverCustomerAccount.ts:46 |
-| `activeFlag` | `boolean` | Indicator for if this account is an active account or not. | models/AccountTakeoverCustomerAccount.ts:86 |
-| `address`? | [`CustomerAccountAddress`](CustomerAccountAddress.md) | - | models/AccountTakeoverCustomerAccount.ts:76 |
-| `emailAddress` | `string` | Email address for the account owner. | models/AccountTakeoverCustomerAccount.ts:66 |
-| `loyaltyMemberId`? | `string` | Unique loyalty identifier for a user. | models/AccountTakeoverCustomerAccount.ts:91 |
-| `name`? | [`AccountTakeoverName`](AccountTakeoverName.md) | - | models/AccountTakeoverCustomerAccount.ts:56 |
-| `registeredTime` | `Date` | The local date and time that the customer first registered on the Partner\'s site, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | models/AccountTakeoverCustomerAccount.ts:81 |
-| `telephones`? | [`Telephone`](Telephone.md)[] | - | models/AccountTakeoverCustomerAccount.ts:71 |
-| `userId` | `string` | Unique account identifier provided by the Partner\'s Identity Provider/System assigned to the account owner by the partner. `user_id` is specific to the Partner\'s namespace. Used to track repeat account activity by the same user. | models/AccountTakeoverCustomerAccount.ts:41 |
-| `username` | `string` | Username of the account. | models/AccountTakeoverCustomerAccount.ts:61 |
+| Property | Type | Description |
+| :------ | :------ | :------ |
+| `accountRole?` | [`AccountTakeoverCustomerAccountAccountRoleEnum`](../type-aliases/AccountTakeoverCustomerAccountAccountRoleEnum.md) | Identifies the account role and associated permissions of a user\'\'s account. Possible values are: - `USER`: Basic account with no special privileges. - `MANAGER`: Account with additional privileges, such as the ability to make bookings for others. - `ADMIN`: Account with higher privileges than a manager, including the ability to grant manager access to other users. |
+| `accountType` | [`AccountTakeoverCustomerAccountAccountTypeEnum`](../type-aliases/AccountTakeoverCustomerAccountAccountTypeEnum.md) | Identifies the account type of a user\'\'s account. Possible values are: - `INDIVIDUAL` - Applicable if this account is for an individual traveler. - `BUSINESS` - Applicable if this account is for a business or organization account used by suppliers or Partners. |
+| `activeFlag` | `boolean` | Indicator for if this account is an active account or not. |
+| `address?` | [`CustomerAccountAddress`](CustomerAccountAddress.md) | - |
+| `emailAddress` | `string` | Email address for the account owner. |
+| `loyaltyMemberId?` | `string` | Unique loyalty identifier for a user. |
+| `name?` | [`AccountTakeoverName`](AccountTakeoverName.md) | - |
+| `registeredTime` | `Date` | The local date and time that the customer first registered on the Partner\'s site, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. |
+| `telephones?` | [`Telephone`](Telephone.md)[] | - |
+| `userId` | `string` | Unique account identifier provided by the Partner\'s Identity Provider/System assigned to the account owner by the partner. `user_id` is specific to the Partner\'s namespace. Used to track repeat account activity by the same user. |
+| `username` | `string` | Username of the account. |

release/fraudPreventionV2/docs/models/classes/AccountTakeoverDeviceDetails.md

@@ -12,7 +12,7 @@ Information specific to the Partner\'s device through which a transaction was ma
 
 #### Parameters
 
-▪ **accountTakeoverDeviceDetails**: [`AccountTakeoverDeviceDetailsProperties`](../interfaces/AccountTakeoverDeviceDetailsProperties.md)
+• **accountTakeoverDeviceDetails**: [`AccountTakeoverDeviceDetailsProperties`](../interfaces/AccountTakeoverDeviceDetailsProperties.md)
 
 #### Returns
 
@@ -24,10 +24,10 @@ models/AccountTakeoverDeviceDetails.ts:54
 
 ## Properties
 
-| Property | Type | Description | Source |
-| :------ | :------ | :------ | :------ |
-| `deviceBox` | `string` | Device related information retrieved from TrustWidget. | models/AccountTakeoverDeviceDetails.ts:37 |
-| `ipAddress` | `string` | IP address of the device used for this event. | models/AccountTakeoverDeviceDetails.ts:42 |
-| `source`? | `string` | Source of the device_box. Default value is `TrustWidget`. | models/AccountTakeoverDeviceDetails.ts:32 |
-| `type`? | [`AccountTakeoverDeviceDetailsTypeEnum`](../type-aliases/AccountTakeoverDeviceDetailsTypeEnum.md) | The categorized type of device used by a user. Possible values are: - `WEBSITE` - Applicable if the user initiated this event from a web browser on a desktop computer. - `PHONE_WEB` - Applicable if the user initiated this event from a web browser on a phone. - `TABLET_WEB` - Applicable if the user initiated this event from a web browser on a tablet. - `PHONE_APP` - Applicable if the user initiated this event from an app on a phone. - `TABLET_APP` - Applicable if the user initiated this event from an app on a tablet. | models/AccountTakeoverDeviceDetails.ts:52 |
-| `userAgent` | `string` | The application type, operating system, software vendor, or software version of the originating request. | models/AccountTakeoverDeviceDetails.ts:47 |
+| Property | Type | Description |
+| :------ | :------ | :------ |
+| `deviceBox` | `string` | Device related information retrieved from TrustWidget. |
+| `ipAddress` | `string` | IP address of the device used for this event. |
+| `source?` | `string` | Source of the device_box. Default value is `TrustWidget`. |
+| `type?` | [`AccountTakeoverDeviceDetailsTypeEnum`](../type-aliases/AccountTakeoverDeviceDetailsTypeEnum.md) | The categorized type of device used by a user. Possible values are: - `WEBSITE` - Applicable if the user initiated this event from a web browser on a desktop computer. - `PHONE_WEB` - Applicable if the user initiated this event from a web browser on a phone. - `TABLET_WEB` - Applicable if the user initiated this event from a web browser on a tablet. - `PHONE_APP` - Applicable if the user initiated this event from an app on a phone. - `TABLET_APP` - Applicable if the user initiated this event from an app on a tablet. |
+| `userAgent` | `string` | The application type, operating system, software vendor, or software version of the originating request. |

release/fraudPreventionV2/docs/models/classes/AccountTakeoverError.md

@@ -12,7 +12,7 @@ The object used to describe an error, containing both human-readable and machine
 
 #### Parameters
 
-▪ **accountTakeoverError**: [`AccountTakeoverErrorProperties`](../interfaces/AccountTakeoverErrorProperties.md)
+• **accountTakeoverError**: [`AccountTakeoverErrorProperties`](../interfaces/AccountTakeoverErrorProperties.md)
 
 #### Returns
 
@@ -24,7 +24,7 @@ models/AccountTakeoverError.ts:39
 
 ## Properties
 
-| Property | Type | Description | Source |
-| :------ | :------ | :------ | :------ |
-| `code` | [`AccountTakeoverErrorCodeEnum`](../type-aliases/AccountTakeoverErrorCodeEnum.md) | Snake cased all caps error code interpreted from the HTTP status code that can programmatically be acted upon. | models/AccountTakeoverError.ts:32 |
-| `message` | `string` | A human-readable explanation of the error, specific to this error occurrence. | models/AccountTakeoverError.ts:37 |
+| Property | Type | Description |
+| :------ | :------ | :------ |
+| `code` | [`AccountTakeoverErrorCodeEnum`](../type-aliases/AccountTakeoverErrorCodeEnum.md) | Snake cased all caps error code interpreted from the HTTP status code that can programmatically be acted upon. |
+| `message` | `string` | A human-readable explanation of the error, specific to this error occurrence. |