Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Publish fraudPreventionV2 [2.0.0] SDK #297

Merged
merged 2 commits into from
Sep 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 0 additions & 1 deletion release/fraudPreventionV2/README.md

This file was deleted.

11 changes: 11 additions & 0 deletions release/fraudPreventionV2/docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
//[openworld-java-sdk-fraudpreventionv2](index.md)

# openworld-java-sdk-fraudpreventionv2

## Packages

| Name |
|---|
| [com.expediagroup.openworld.sdk.fraudpreventionv2.client](openworld-java-sdk-fraudpreventionv2/com.expediagroup.openworld.sdk.fraudpreventionv2.client/index.md) |
| [com.expediagroup.openworld.sdk.fraudpreventionv2.models](openworld-java-sdk-fraudpreventionv2/com.expediagroup.openworld.sdk.fraudpreventionv2.models/index.md) |
| [com.expediagroup.openworld.sdk.fraudpreventionv2.models.exception](openworld-java-sdk-fraudpreventionv2/com.expediagroup.openworld.sdk.fraudpreventionv2.models.exception/index.md) |
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
//[openworld-java-sdk-fraudpreventionv2](../../../../index.md)/[com.expediagroup.openworld.sdk.fraudpreventionv2.client](../../index.md)/[FraudPreventionV2Client](../index.md)/[Builder](index.md)/[FraudPreventionV2Client.Builder](-fraud-prevention-v2-client.-builder.md)

# FraudPreventionV2Client.Builder

[JVM]\

public [FraudPreventionV2Client.Builder](index.md)[FraudPreventionV2Client.Builder](-fraud-prevention-v2-client.-builder.md)()
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
//[openworld-java-sdk-fraudpreventionv2](../../../../index.md)/[com.expediagroup.openworld.sdk.fraudpreventionv2.client](../../index.md)/[FraudPreventionV2Client](../index.md)/[Builder](index.md)/[build](build.md)

# build

[JVM]\

public [FraudPreventionV2Client](../index.md)[build](build.md)()
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
//[openworld-java-sdk-fraudpreventionv2](../../../../index.md)/[com.expediagroup.openworld.sdk.fraudpreventionv2.client](../../index.md)/[FraudPreventionV2Client](../index.md)/[Builder](index.md)

# Builder

[JVM]\
public final class [Builder](index.md) extends OpenWorldClient.Builder<[FraudPreventionV2Client.Builder](index.md)>

## Constructors

| | |
|---|---|
| [FraudPreventionV2Client.Builder](-fraud-prevention-v2-client.-builder.md) | [JVM]<br>public [FraudPreventionV2Client.Builder](index.md)[FraudPreventionV2Client.Builder](-fraud-prevention-v2-client.-builder.md)() |

## Functions

| Name | Summary |
|---|---|
| [authEndpoint](index.md#1094333624%2FFunctions%2F-1883119931) | [JVM]<br>public final [FraudPreventionV2Client.Builder](index.md)[authEndpoint](index.md#1094333624%2FFunctions%2F-1883119931)([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)authEndpoint) |
| [build](build.md) | [JVM]<br>public [FraudPreventionV2Client](../index.md)[build](build.md)() |
| [endpoint](index.md#-1896943986%2FFunctions%2F-1883119931) | [JVM]<br>public final [FraudPreventionV2Client.Builder](index.md)[endpoint](index.md#-1896943986%2FFunctions%2F-1883119931)([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)endpoint) |
| [key](index.md#199826420%2FFunctions%2F-1883119931) | [JVM]<br>public final [FraudPreventionV2Client.Builder](index.md)[key](index.md#199826420%2FFunctions%2F-1883119931)([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)key) |
| [requestTimeout](index.md#1450162560%2FFunctions%2F-1883119931) | [JVM]<br>public final [FraudPreventionV2Client.Builder](index.md)[requestTimeout](index.md#1450162560%2FFunctions%2F-1883119931)([Long](https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html)milliseconds) |
| [secret](index.md#1635278825%2FFunctions%2F-1883119931) | [JVM]<br>public final [FraudPreventionV2Client.Builder](index.md)[secret](index.md#1635278825%2FFunctions%2F-1883119931)([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)secret) |
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
//[openworld-java-sdk-fraudpreventionv2](../../../index.md)/[com.expediagroup.openworld.sdk.fraudpreventionv2.client](../index.md)/[FraudPreventionV2Client](index.md)/[builder](builder.md)

# builder

[JVM]\

public final static [FraudPreventionV2Client.Builder](-builder/index.md)[builder](builder.md)()
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
//[openworld-java-sdk-fraudpreventionv2](../../../index.md)/[com.expediagroup.openworld.sdk.fraudpreventionv2.client](../index.md)/[FraudPreventionV2Client](index.md)

# FraudPreventionV2Client

[JVM]\
public final class [FraudPreventionV2Client](index.md) extends OpenWorldClient

## Types

| Name | Summary |
|---|---|
| [Builder](-builder/index.md) | [JVM]<br>public final class [Builder](-builder/index.md) extends OpenWorldClient.Builder&lt;[FraudPreventionV2Client.Builder](-builder/index.md)&gt; |

## Functions

| Name | Summary |
|---|---|
| [builder](builder.md) | [JVM]<br>public final static [FraudPreventionV2Client.Builder](-builder/index.md)[builder](builder.md)() |
| [fireAuthIssue](index.md#97375875%2FFunctions%2F-1883119931) | [JVM]<br>public final [Void](https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html)[fireAuthIssue](index.md#97375875%2FFunctions%2F-1883119931)([String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)message) |
| [getHttpClient](index.md#1832677461%2FFunctions%2F-1883119931) | [JVM]<br>public HttpClient[getHttpClient](index.md#1832677461%2FFunctions%2F-1883119931)() |
| [notifyWithAccountUpdate](notify-with-account-update.md) | [JVM]<br>@[JvmOverloads](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html)()<br>public final [AccountUpdateResponse](../../com.expediagroup.openworld.sdk.fraudpreventionv2.models/-account-update-response/index.md)[notifyWithAccountUpdate](notify-with-account-update.md)([AccountUpdateRequest](../../com.expediagroup.openworld.sdk.fraudpreventionv2.models/-account-update-request/index.md)accountUpdateRequest)<br>@[JvmOverloads](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html)()<br>public final [AccountUpdateResponse](../../com.expediagroup.openworld.sdk.fraudpreventionv2.models/-account-update-response/index.md)[notifyWithAccountUpdate](notify-with-account-update.md)([AccountUpdateRequest](../../com.expediagroup.openworld.sdk.fraudpreventionv2.models/-account-update-request/index.md)accountUpdateRequest, [UUID](https://docs.oracle.com/javase/8/docs/api/java/util/UUID.html)transactionId)<br>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. |
| [notifyWithOrderUpdate](notify-with-order-update.md) | [JVM]<br>@[JvmOverloads](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html)()<br>public final [OrderPurchaseUpdateResponse](../../com.expediagroup.openworld.sdk.fraudpreventionv2.models/-order-purchase-update-response/index.md)[notifyWithOrderUpdate](notify-with-order-update.md)([OrderPurchaseUpdateRequest](../../com.expediagroup.openworld.sdk.fraudpreventionv2.models/-order-purchase-update-request/index.md)orderPurchaseUpdateRequest)<br>@[JvmOverloads](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html)()<br>public final [OrderPurchaseUpdateResponse](../../com.expediagroup.openworld.sdk.fraudpreventionv2.models/-order-purchase-update-response/index.md)[notifyWithOrderUpdate](notify-with-order-update.md)([OrderPurchaseUpdateRequest](../../com.expediagroup.openworld.sdk.fraudpreventionv2.models/-order-purchase-update-request/index.md)orderPurchaseUpdateRequest, [UUID](https://docs.oracle.com/javase/8/docs/api/java/util/UUID.html)transactionId)<br>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. |
| [screenAccount](screen-account.md) | [JVM]<br>@[JvmOverloads](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html)()<br>public final [AccountScreenResponse](../../com.expediagroup.openworld.sdk.fraudpreventionv2.models/-account-screen-response/index.md)[screenAccount](screen-account.md)([AccountScreenRequest](../../com.expediagroup.openworld.sdk.fraudpreventionv2.models/-account-screen-request/index.md)accountScreenRequest)<br>@[JvmOverloads](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html)()<br>public final [AccountScreenResponse](../../com.expediagroup.openworld.sdk.fraudpreventionv2.models/-account-screen-response/index.md)[screenAccount](screen-account.md)([AccountScreenRequest](../../com.expediagroup.openworld.sdk.fraudpreventionv2.models/-account-screen-request/index.md)accountScreenRequest, [UUID](https://docs.oracle.com/javase/8/docs/api/java/util/UUID.html)transactionId)<br>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. |
| [screenOrder](screen-order.md) | [JVM]<br>@[JvmOverloads](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html)()<br>public final [OrderPurchaseScreenResponse](../../com.expediagroup.openworld.sdk.fraudpreventionv2.models/-order-purchase-screen-response/index.md)[screenOrder](screen-order.md)([OrderPurchaseScreenRequest](../../com.expediagroup.openworld.sdk.fraudpreventionv2.models/-order-purchase-screen-request/index.md)orderPurchaseScreenRequest)<br>@[JvmOverloads](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html)()<br>public final [OrderPurchaseScreenResponse](../../com.expediagroup.openworld.sdk.fraudpreventionv2.models/-order-purchase-screen-response/index.md)[screenOrder](screen-order.md)([OrderPurchaseScreenRequest](../../com.expediagroup.openworld.sdk.fraudpreventionv2.models/-order-purchase-screen-request/index.md)orderPurchaseScreenRequest, [UUID](https://docs.oracle.com/javase/8/docs/api/java/util/UUID.html)transactionId)<br>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. |
| [throwIfError](index.md#141038589%2FFunctions%2F-1883119931) | [JVM]<br>public final [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)[throwIfError](index.md#141038589%2FFunctions%2F-1883119931)(HttpResponseresponse, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)operationId) |
| [throwServiceException](throw-service-exception.md) | [JVM]<br>public [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)[throwServiceException](throw-service-exception.md)(HttpResponseresponse, [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)operationId) |

## Properties

| Name | Summary |
|---|---|
| [httpClient](index.md#1889836393%2FProperties%2F-1883119931) | [JVM]<br>private final HttpClient[httpClient](index.md#1889836393%2FProperties%2F-1883119931) |
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
//[openworld-java-sdk-fraudpreventionv2](../../../index.md)/[com.expediagroup.openworld.sdk.fraudpreventionv2.client](../index.md)/[FraudPreventionV2Client](index.md)/[notifyWithAccountUpdate](notify-with-account-update.md)

# notifyWithAccountUpdate

[JVM]\

@[JvmOverloads](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html)()

public final [AccountUpdateResponse](../../com.expediagroup.openworld.sdk.fraudpreventionv2.models/-account-update-response/index.md)[notifyWithAccountUpdate](notify-with-account-update.md)([AccountUpdateRequest](../../com.expediagroup.openworld.sdk.fraudpreventionv2.models/-account-update-request/index.md)accountUpdateRequest, [UUID](https://docs.oracle.com/javase/8/docs/api/java/util/UUID.html)transactionId)

@[JvmOverloads](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html)()

public final [AccountUpdateResponse](../../com.expediagroup.openworld.sdk.fraudpreventionv2.models/-account-update-response/index.md)[notifyWithAccountUpdate](notify-with-account-update.md)([AccountUpdateRequest](../../com.expediagroup.openworld.sdk.fraudpreventionv2.models/-account-update-request/index.md)accountUpdateRequest)

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.

#### Return

AccountUpdateResponse

#### Parameters

JVM

| | |
|---|---|
| accountUpdateRequest | An AccountUpdate request may be of one of the following types `MULTI_FACTOR_AUTHENTICATION_UPDATE`, `REMEDIATION_UPDATE`. |

#### Throws

| |
|---|
| [OpenWorldApiAccountTakeoverBadRequestErrorException](../../com.expediagroup.openworld.sdk.fraudpreventionv2.models.exception/-open-world-api-account-takeover-bad-request-error-exception/index.md) |
| [OpenWorldApiAccountTakeoverUnauthorizedErrorException](../../com.expediagroup.openworld.sdk.fraudpreventionv2.models.exception/-open-world-api-account-takeover-unauthorized-error-exception/index.md) |
| [OpenWorldApiForbiddenErrorException](../../com.expediagroup.openworld.sdk.fraudpreventionv2.models.exception/-open-world-api-forbidden-error-exception/index.md) |
| [OpenWorldApiAccountUpdateNotFoundErrorException](../../com.expediagroup.openworld.sdk.fraudpreventionv2.models.exception/-open-world-api-account-update-not-found-error-exception/index.md) |
| [OpenWorldApiTooManyRequestsErrorException](../../com.expediagroup.openworld.sdk.fraudpreventionv2.models.exception/-open-world-api-too-many-requests-error-exception/index.md) |
| [OpenWorldApiInternalServerErrorException](../../com.expediagroup.openworld.sdk.fraudpreventionv2.models.exception/-open-world-api-internal-server-error-exception/index.md) |
| [OpenWorldApiBadGatewayErrorException](../../com.expediagroup.openworld.sdk.fraudpreventionv2.models.exception/-open-world-api-bad-gateway-error-exception/index.md) |
| [OpenWorldApiAccountTakeoverServiceUnavailableErrorException](../../com.expediagroup.openworld.sdk.fraudpreventionv2.models.exception/-open-world-api-account-takeover-service-unavailable-error-exception/index.md) |
| [OpenWorldApiGatewayTimeoutErrorException](../../com.expediagroup.openworld.sdk.fraudpreventionv2.models.exception/-open-world-api-gateway-timeout-error-exception/index.md) |
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
//[openworld-java-sdk-fraudpreventionv2](../../../index.md)/[com.expediagroup.openworld.sdk.fraudpreventionv2.client](../index.md)/[FraudPreventionV2Client](index.md)/[notifyWithOrderUpdate](notify-with-order-update.md)

# notifyWithOrderUpdate

[JVM]\

@[JvmOverloads](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html)()

public final [OrderPurchaseUpdateResponse](../../com.expediagroup.openworld.sdk.fraudpreventionv2.models/-order-purchase-update-response/index.md)[notifyWithOrderUpdate](notify-with-order-update.md)([OrderPurchaseUpdateRequest](../../com.expediagroup.openworld.sdk.fraudpreventionv2.models/-order-purchase-update-request/index.md)orderPurchaseUpdateRequest, [UUID](https://docs.oracle.com/javase/8/docs/api/java/util/UUID.html)transactionId)

@[JvmOverloads](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html)()

public final [OrderPurchaseUpdateResponse](../../com.expediagroup.openworld.sdk.fraudpreventionv2.models/-order-purchase-update-response/index.md)[notifyWithOrderUpdate](notify-with-order-update.md)([OrderPurchaseUpdateRequest](../../com.expediagroup.openworld.sdk.fraudpreventionv2.models/-order-purchase-update-request/index.md)orderPurchaseUpdateRequest)

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.

#### Return

OrderPurchaseUpdateResponse

#### Parameters

JVM

| | |
|---|---|
| orderPurchaseUpdateRequest | An OrderPurchaseUpdate request may be of one of the following types `ORDER_UPDATE`, `CHARGEBACK_FEEDBACK`, `INSULT_FEEDBACK`, `REFUND_UPDATE`, `PAYMENT_UPDATE`. |

#### Throws

| |
|---|
| [OpenWorldApiBadRequestErrorException](../../com.expediagroup.openworld.sdk.fraudpreventionv2.models.exception/-open-world-api-bad-request-error-exception/index.md) |
| [OpenWorldApiUnauthorizedErrorException](../../com.expediagroup.openworld.sdk.fraudpreventionv2.models.exception/-open-world-api-unauthorized-error-exception/index.md) |
| [OpenWorldApiForbiddenErrorException](../../com.expediagroup.openworld.sdk.fraudpreventionv2.models.exception/-open-world-api-forbidden-error-exception/index.md) |
| [OpenWorldApiOrderPurchaseUpdateNotFoundErrorException](../../com.expediagroup.openworld.sdk.fraudpreventionv2.models.exception/-open-world-api-order-purchase-update-not-found-error-exception/index.md) |
| [OpenWorldApiTooManyRequestsErrorException](../../com.expediagroup.openworld.sdk.fraudpreventionv2.models.exception/-open-world-api-too-many-requests-error-exception/index.md) |
| [OpenWorldApiInternalServerErrorException](../../com.expediagroup.openworld.sdk.fraudpreventionv2.models.exception/-open-world-api-internal-server-error-exception/index.md) |
| [OpenWorldApiBadGatewayErrorException](../../com.expediagroup.openworld.sdk.fraudpreventionv2.models.exception/-open-world-api-bad-gateway-error-exception/index.md) |
| [OpenWorldApiServiceUnavailableErrorException](../../com.expediagroup.openworld.sdk.fraudpreventionv2.models.exception/-open-world-api-service-unavailable-error-exception/index.md) |
| [OpenWorldApiGatewayTimeoutErrorException](../../com.expediagroup.openworld.sdk.fraudpreventionv2.models.exception/-open-world-api-gateway-timeout-error-exception/index.md) |
Loading