chore: Publish fraudPreventionV2 [2.1.0] SDK (#248)

PR: #248
ExpediaGroup · Oct 4, 2023 · 1d1c514 · 1d1c514
1 parent d19a599
commit 1d1c514
Show file tree

Hide file tree

Showing 176 changed files with 7,336 additions and 62 deletions.
diff --git a/release/fraudPreventionV2/docs/AccountRole.md b/release/fraudPreventionV2/docs/AccountRole.md
@@ -0,0 +1,41 @@
+[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [AccountRole](AccountRole.md)
+# class `expediagroup.sdk.fraudpreventionv2.model.AccountRole`
+```
+AccountRole(
+)
+```
+
+pydantic model AccountRole: Identifies the account role and associated permissions of a user''s account. Possible values are:
+- `USER`: Basic account with no special privileges.
+- `MANAGER`: Account with additional privileges, such as the ability to make bookings for others.
+- `ADMIN`: Account with higher privileges than a manager, including the ability to grant manager access to other users.
+
+
+
+## Attributes
+
+
+        
+
+        
+
+        
+
+
+|   Name  | Type | Required | Description |
+|---------|------|----------|-------------|
+|  ADMIN  | Any  |   True   |     ...     |
+| MANAGER | Any  |   True   |     ...     |
+|   USER  | Any  |   True   |     ...     |
+
+
+
+
+
+
+
+
+
+
+# Inheritance
+object > Enum > AccountRole
diff --git a/release/fraudPreventionV2/docs/AccountScreenRequest.md b/release/fraudPreventionV2/docs/AccountScreenRequest.md
@@ -0,0 +1,33 @@
+[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [AccountScreenRequest](AccountScreenRequest.md)
+# class `expediagroup.sdk.fraudpreventionv2.model.AccountScreenRequest`
+```
+AccountScreenRequest(
+    transaction: AccountTransaction,
+)
+```
+
+pydantic model AccountScreenRequest: Information for account screening by Expedia's Fraud Prevention Service.
+
+
+
+## Attributes
+
+
+        
+
+
+|     Name    |                     Type                    | Required | Description |
+|-------------|---------------------------------------------|----------|-------------|
+| transaction | [AccountTransaction](AccountTransaction.md) |   True   |     ...     |
+
+
+
+
+
+
+
+
+
+
+# Inheritance
+object > BaseModel > AccountScreenRequest
diff --git a/release/fraudPreventionV2/docs/AccountScreenResponse.md b/release/fraudPreventionV2/docs/AccountScreenResponse.md
@@ -0,0 +1,37 @@
+[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [AccountScreenResponse](AccountScreenResponse.md)
+# class `expediagroup.sdk.fraudpreventionv2.model.AccountScreenResponse`
+```
+AccountScreenResponse(
+    risk_id: Optional[constr(max_length=200)],
+    decision: Optional[AccountTakeoverFraudDecision],
+)
+```
+
+pydantic model AccountScreenResponse: Response for an account transaction provided by Expedia's Fraud Prevention Service.
+
+
+
+## Attributes
+
+
+        
+
+        
+
+
+|   Name   |                                    Type                                   | Required |                                     Description                                      |
+|----------|---------------------------------------------------------------------------|----------|--------------------------------------------------------------------------------------|
+| decision | Optional[[AccountTakeoverFraudDecision](AccountTakeoverFraudDecision.md)] |  False   |                                         ...                                          |
+| risk_id  |                      Optional[constr(max_length=200)]                     |  False   | Unique identifier assigned to the transaction by Expedia's Fraud Prevention Service. |
+
+
+
+
+
+
+
+
+
+
+# Inheritance
+object > BaseModel > AccountScreenResponse
diff --git a/release/fraudPreventionV2/docs/AccountTakeoverBadRequestError.md b/release/fraudPreventionV2/docs/AccountTakeoverBadRequestError.md
@@ -0,0 +1,33 @@
+[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [AccountTakeoverBadRequestError](AccountTakeoverBadRequestError.md)
+# class `expediagroup.sdk.fraudpreventionv2.model.AccountTakeoverBadRequestError`
+```
+AccountTakeoverBadRequestError(
+    causes: Optional[list[Cause1]],
+)
+```
+
+pydantic model AccountTakeoverBadRequestError: Indicates that a bad request occurred. Typically it is an invalid parameter.
+
+
+
+## Attributes
+
+
+        
+
+
+|  Name  |                 Type                | Required | Description |
+|--------|-------------------------------------|----------|-------------|
+| causes | Optional[list[[Cause1](Cause1.md)]] |  False   |     ...     |
+
+
+
+
+
+
+
+
+
+
+# Inheritance
+object > [AccountTakeoverError](AccountTakeoverError.md) > AccountTakeoverBadRequestError
diff --git a/...fraudPreventionV2/docs/AccountTakeoverBadRequestErrorDeserializationContract.md b/...fraudPreventionV2/docs/AccountTakeoverBadRequestErrorDeserializationContract.md
@@ -0,0 +1,37 @@
+[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [AccountTakeoverBadRequestErrorDeserializationContract](AccountTakeoverBadRequestErrorDeserializationContract.md)
+# class `expediagroup.sdk.fraudpreventionv2.model.AccountTakeoverBadRequestErrorDeserializationContract`
+```
+AccountTakeoverBadRequestErrorDeserializationContract(
+    exception: type,
+    model: type,
+)
+```
+
+
+
+
+
+## Attributes
+
+
+        
+
+        
+
+
+|    Name   | Type | Required | Description |
+|-----------|------|----------|-------------|
+| exception | type |   True   |     ...     |
+|   model   | type |   True   |     ...     |
+
+
+
+
+
+
+
+
+
+
+# Inheritance
+object  > AccountTakeoverBadRequestErrorDeserializationContract
diff --git a/release/fraudPreventionV2/docs/AccountTakeoverCustomerAccount.md b/release/fraudPreventionV2/docs/AccountTakeoverCustomerAccount.md
@@ -0,0 +1,73 @@
+[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [AccountTakeoverCustomerAccount](AccountTakeoverCustomerAccount.md)
+# class `expediagroup.sdk.fraudpreventionv2.model.AccountTakeoverCustomerAccount`
+```
+AccountTakeoverCustomerAccount(
+    user_id: constr(max_length=200),
+    account_type: AccountType1,
+    account_role: Optional[AccountRole],
+    name: Optional[AccountTakeoverName],
+    username: constr(max_length=200),
+    email_address: EmailStr,
+    telephones: Optional[list[Telephone]],
+    address: Optional[Address],
+    registered_time: datetime,
+    active_flag: bool,
+    loyalty_member_id: Optional[constr(max_length=200)],
+)
+```
+
+pydantic model AccountTakeoverCustomerAccount: Information about a user's account.
+
+
+
+## Attributes
+
+
+        
+
+        
+
+        
+
+        
+
+        
+
+        
+
+        
+
+        
+
+        
+
+        
+
+        
+
+
+|        Name       |                           Type                          | Required |                                                                                                                                                                                         Description                                                                                                                                                                                         |
+|-------------------|---------------------------------------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+|    account_role   |         Optional[[AccountRole](AccountRole.md)]         |  False   | Identifies the account role and associated permissions of a user''s account. Possible values are:<br/>- `USER`: Basic account with no special privileges.<br/>- `MANAGER`: Account with additional privileges, such as the ability to make bookings for others.<br/>- `ADMIN`: Account with higher privileges than a manager, including the ability to grant manager access to other users. |
+|    account_type   |             [AccountType1](AccountType1.md)             |   True   |                                                         Identifies the account type of a user''s account. Possible values are:<br/>- `INDIVIDUAL` - Applicable if this account is for an individual traveler.<br/>- `BUSINESS` - Applicable if this account is for a business or organization account used by suppliers or Partners.                                                        |
+|    active_flag    |                           bool                          |   True   |                                                                                                                                                                  Indicator for if this account is an active account or not.                                                                                                                                                                 |
+|      address      |             Optional[[Address](Address.md)]             |  False   |                                                                                                                                                                                             ...                                                                                                                                                                                             |
+|   email_address   |                         EmailStr                        |   True   |                                                                                                                                                                             Email address for the account owner.                                                                                                                                                                            |
+| loyalty_member_id |             Optional[constr(max_length=200)]            |  False   |                                                                                                                                                                            Unique loyalty identifier for a user.                                                                                                                                                                            |
+|        name       | Optional[[AccountTakeoverName](AccountTakeoverName.md)] |  False   |                                                                                                                                                                                             ...                                                                                                                                                                                             |
+|  registered_time  |                         datetime                        |   True   |                                                                                                                        The local date and time that the customer first registered on the Partner's site, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`.                                                                                                                       |
+|     telephones    |        Optional[list[[Telephone](Telephone.md)]]        |  False   |                                                                                                                                                                                             ...                                                                                                                                                                                             |
+|      user_id      |                  constr(max_length=200)                 |   True   |                                                                             Unique account identifier provided by the Partner's Identity Provider/System assigned to the account owner by the partner. `user_id` is specific to the Partner's namespace. Used to track repeat account activity by the same user.                                                                            |
+|      username     |                  constr(max_length=200)                 |   True   |                                                                                                                                                                                   Username of the account.                                                                                                                                                                                  |
+
+
+
+
+
+
+
+
+
+
+# Inheritance
+object > BaseModel > AccountTakeoverCustomerAccount
diff --git a/release/fraudPreventionV2/docs/AccountTakeoverDeviceDetails.md b/release/fraudPreventionV2/docs/AccountTakeoverDeviceDetails.md
@@ -0,0 +1,51 @@
+[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [AccountTakeoverDeviceDetails](AccountTakeoverDeviceDetails.md)
+# class `expediagroup.sdk.fraudpreventionv2.model.AccountTakeoverDeviceDetails`
+```
+AccountTakeoverDeviceDetails(
+    source: Optional[constr(max_length=50)],
+    device_box: constr(max_length=16000),
+    ip_address: constr(
+        regex=r"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^(?:[A-F0-9]{1,4}:){7}[A-F0-9]{1,4}$"
+    ),
+    user_agent: constr(max_length=200),
+    type: Optional[Type2],
+)
+```
+
+pydantic model AccountTakeoverDeviceDetails: Information specific to the Partner's device through which a transaction was made.
+
+
+
+## Attributes
+
+
+        
+
+        
+
+        
+
+        
+
+        
+
+
+|    Name    |                                                                                     Type                                                                                     | Required |                                                                                                                                                                                                                                                                          Description                                                                                                                                                                                                                                                                          |
+|------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| device_box |                                                                           constr(max_length=16000)                                                                           |   True   |                                                                                                                                                                                                                                                     Device related information retrieved from TrustWidget.                                                                                                                                                                                                                                                    |
+| ip_address | constr(<br/>        regex=r"^(?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)$\|^(?:[A-F0-9]{1,4}:){7}[A-F0-9]{1,4}$"<br/>    ) |   True   |                                                                                                                                                                                                                                                         IP address of the device used for this event.                                                                                                                                                                                                                                                         |
+|   source   |                                                                       Optional[constr(max_length=50)]                                                                        |  False   |                                                                                                                                                                                                                                                   Source of the device_box. Default value is `TrustWidget`.                                                                                                                                                                                                                                                   |
+|    type    |                                                                         Optional[[Type2](Type2.md)]                                                                          |  False   | The categorized type of device used by a user. Possible values are:<br/>- `WEBSITE` - Applicable if the user initiated this event from a web browser on a desktop computer.<br/>- `PHONE_WEB` - Applicable if the user initiated this event from a web browser on a phone.<br/>- `TABLET_WEB` - Applicable if the user initiated this event from a web browser on a tablet.<br/>- `PHONE_APP` - Applicable if the user initiated this event from an app on a phone.<br/>- `TABLET_APP` - Applicable if the user initiated this event from an app on a tablet. |
+| user_agent |                                                                            constr(max_length=200)                                                                            |   True   |                                                                                                                                                                                                                            The application type, operating system, software vendor, or software version of the originating request.                                                                                                                                                                                                                           |
+
+
+
+
+
+
+
+
+
+
+# Inheritance
+object > BaseModel > AccountTakeoverDeviceDetails
diff --git a/release/fraudPreventionV2/docs/AccountTakeoverError.md b/release/fraudPreventionV2/docs/AccountTakeoverError.md
@@ -0,0 +1,37 @@
+[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [AccountTakeoverError](AccountTakeoverError.md)
+# class `expediagroup.sdk.fraudpreventionv2.model.AccountTakeoverError`
+```
+AccountTakeoverError(
+    code: Code2,
+    message: str,
+)
+```
+
+pydantic model AccountTakeoverError: The object used to describe an error, containing both human-readable and machine-readable information.
+
+
+
+## Attributes
+
+
+        
+
+        
+
+
+|   Name  |        Type       | Required |                                                  Description                                                   |
+|---------|-------------------|----------|----------------------------------------------------------------------------------------------------------------|
+|   code  | [Code2](Code2.md) |   True   | Snake cased all caps error code interpreted from the HTTP status code that can programmatically be acted upon. |
+| message |        str        |   True   |                 A human-readable explanation of the error, specific to this error occurrence.                  |
+
+
+
+
+
+
+
+
+
+
+# Inheritance
+object > BaseModel > AccountTakeoverError