Skip to content

Commit

Permalink
fix: fix backtick problem in comments and documentation
Browse files Browse the repository at this point in the history
but not in modes, because of wrong template problem
  • Loading branch information
ilfa committed Jun 5, 2023
1 parent 118e7a1 commit 10ade24
Show file tree
Hide file tree
Showing 34 changed files with 197 additions and 70 deletions.
2 changes: 1 addition & 1 deletion docs/BotdDetectionResult.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Stores bot detection result

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**result** | [**ResultEnum**](#ResultEnum) | Bot detection result: * `notDetected` - the visitor is not a bot * `good` - good bot detected, such as Google bot, Baidu Spider, AlexaBot and so on * `bad` - bad bot detected, such as Selenium, Puppeteer, Playwright, headless browsers, and so on | |
|**result** | [**ResultEnum**](#ResultEnum) | Bot detection result: * `notDetected` - the visitor is not a bot * `good` - good bot detected, such as Google bot, Baidu Spider, AlexaBot and so on * `bad` - bad bot detected, such as Selenium, Puppeteer, Playwright, headless browsers, and so on | |
|**type** | **String** | | [optional] |


Expand Down
2 changes: 1 addition & 1 deletion docs/ErrorEvent403ResponseError.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**code** | [**CodeEnum**](#CodeEnum) | Error code: * `TokenRequired` - `Auth-API-Key` header is missing or empty * `TokenNotFound` - subscription not found for specified secret key * `SubscriptionNotActive` - subscription is not active * `WrongRegion` - server and subscription region differ | |
|**code** | [**CodeEnum**](#CodeEnum) | Error code: * `TokenRequired` - `Auth-API-Key` header is missing or empty * `TokenNotFound` - subscription not found for specified secret key * `SubscriptionNotActive` - subscription is not active * `WrongRegion` - server and subscription region differ | |
|**message** | **String** | | |


Expand Down
2 changes: 1 addition & 1 deletion docs/ErrorEvent404ResponseError.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**code** | [**CodeEnum**](#CodeEnum) | Error code: * `RequestNotFound` - request not found for specified id | |
|**code** | [**CodeEnum**](#CodeEnum) | Error code: * `RequestNotFound` - request not found for specified id | |
|**message** | **String** | | |


Expand Down
10 changes: 5 additions & 5 deletions docs/FingerprintApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,11 +155,11 @@ public class FingerprintApiExample {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **visitorId** | **String**| Unique identifier of the visitor issued by Fingerprint Pro. | |
| **requestId** | **String**| Filter visits by `requestId`. Every identification request has a unique identifier associated with it called `requestId`. This identifier is returned to the client in the identification [result](https://dev.fingerprint.com/docs/js-agent#requestid). When you filter visits by `requestId`, only one visit will be returned. | [optional] |
| **linkedId** | **String**| Filter visits by your custom identifier. You can use [`linkedId`](https://dev.fingerprint.com/docs/js-agent#linkedid) to associate identification requests with your own identifier, for example: session ID, purchase ID, or transaction ID. You can then use this `linked_id` parameter to retrieve all events associated with your custom identifier. | [optional] |
| **limit** | **Integer**| Limit scanned results. For performance reasons, the API first scans some number of events before filtering them. Use `limit` to specify how many events are scanned before they are filtered by `requestId` or `linkedId`. Results are always returned sorted by the timestamp (most recent first). By default, the most recent 100 visits are scanned, the maximum is 500. | [optional] |
| **paginationKey** | **String**| Use `paginationKey` to get the next page of results. When more results are available (e.g., you requested 200 results using `limit` parameter, but a total of 600 results are available), the `paginationKey` top-level attribute is added to the response. The key corresponds to the `requestId` of the last returned event. In the following request, use that value in the `paginationKey` parameter to get the next page of results: 1. First request, returning most recent 200 events: `GET api-base-url/visitors/:visitorId?limit=200` 2. Use `response.paginationKey` to get the next page of results: `GET api-base-url/visitors/:visitorId?limit=200&paginationKey=1683900801733.Ogvu1j` Pagination happens during scanning and before filtering, so you can get less visits than the `limit` you specified with more available on the next page. When there are no more results available for scanning, the `paginationKey` attribute is not returned. | [optional] |
| **before** | **Long**| ⚠️ Deprecated pagination method, please use `paginationKey` instead. Timestamp (in milliseconds since epoch) used to paginate results. | [optional] |
| **requestId** | **String**| Filter visits by `requestId`. Every identification request has a unique identifier associated with it called `requestId`. This identifier is returned to the client in the identification [result](https://dev.fingerprint.com/docs/js-agent#requestid). When you filter visits by `requestId`, only one visit will be returned. | [optional] |
| **linkedId** | **String**| Filter visits by your custom identifier. You can use [`linkedId`](https://dev.fingerprint.com/docs/js-agent#linkedid) to associate identification requests with your own identifier, for example: session ID, purchase ID, or transaction ID. You can then use this `linked_id` parameter to retrieve all events associated with your custom identifier. | [optional] |
| **limit** | **Integer**| Limit scanned results. For performance reasons, the API first scans some number of events before filtering them. Use `limit` to specify how many events are scanned before they are filtered by `requestId` or `linkedId`. Results are always returned sorted by the timestamp (most recent first). By default, the most recent 100 visits are scanned, the maximum is 500. | [optional] |
| **paginationKey** | **String**| Use `paginationKey` to get the next page of results. When more results are available (e.g., you requested 200 results using `limit` parameter, but a total of 600 results are available), the `paginationKey` top-level attribute is added to the response. The key corresponds to the `requestId` of the last returned event. In the following request, use that value in the `paginationKey` parameter to get the next page of results: 1. First request, returning most recent 200 events: `GET api-base-url/visitors/:visitorId?limit=200` 2. Use `response.paginationKey` to get the next page of results: `GET api-base-url/visitors/:visitorId?limit=200&paginationKey=1683900801733.Ogvu1j` Pagination happens during scanning and before filtering, so you can get less visits than the `limit` you specified with more available on the next page. When there are no more results available for scanning, the `paginationKey` attribute is not returned. | [optional] |
| **before** | **Long**| ⚠️ Deprecated pagination method, please use `paginationKey` instead. Timestamp (in milliseconds since epoch) used to paginate results. | [optional] |

### Return type

Expand Down
2 changes: 1 addition & 1 deletion docs/IdentificationError.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**code** | [**CodeEnum**](#CodeEnum) | Error code: * `429 Too Many Requests` - the limit on secret API key requests per second has been exceeded * `Failed` - internal server error | |
|**code** | [**CodeEnum**](#CodeEnum) | Error code: * `429 Too Many Requests` - the limit on secret API key requests per second has been exceeded * `Failed` - internal server error | |
|**message** | **String** | | |


Expand Down
2 changes: 1 addition & 1 deletion docs/IpBlockListResult.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**result** | **Boolean** | `true` if request IP address is part of any database that we use to search for known malicious actors, `false` otherwise. | [optional] |
|**result** | **Boolean** | `true` if request IP address is part of any database that we use to search for known malicious actors, `false` otherwise. | [optional] |
|**details** | [**IpBlockListResultDetails**](IpBlockListResultDetails.md) | | [optional] |


Expand Down
2 changes: 1 addition & 1 deletion docs/ProductError.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**code** | [**CodeEnum**](#CodeEnum) | Error code: * `TooManyRequests` - the limit on secret API key requests per second has been exceeded * `Failed` - internal server error | |
|**code** | [**CodeEnum**](#CodeEnum) | Error code: * `TooManyRequests` - the limit on secret API key requests per second has been exceeded * `Failed` - internal server error | |
|**message** | **String** | | |


Expand Down
2 changes: 1 addition & 1 deletion docs/ProductsResponseIdentificationData.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**requestId** | **String** | Unique identifier of the user's identification request. | |
|**requestId** | **String** | Unique identifier of the user's identification request. | |
|**browserDetails** | [**BrowserDetails**](BrowserDetails.md) | | |
|**incognito** | **Boolean** | Flag if user used incognito session. | |
|**ip** | **String** | | |
Expand Down
4 changes: 2 additions & 2 deletions docs/Response.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ Fields `lastTimestamp` and `paginationKey` added when `limit` or `before` parame
|------------ | ------------- | ------------- | -------------|
|**visitorId** | **String** | | |
|**visits** | [**List<ResponseVisits>**](ResponseVisits.md) | | |
|**lastTimestamp** | **Long** | ⚠️ Deprecated paging attribute, please use `paginationKey` instead. Timestamp of the last visit in the current page of results. | [optional] |
|**paginationKey** | **String** | Request ID of the last visit in the current page of results. Use this value in the following request as the `paginationKey` parameter to get the next page of results. | [optional] |
|**lastTimestamp** | **Long** | ⚠️ Deprecated paging attribute, please use `paginationKey` instead. Timestamp of the last visit in the current page of results. | [optional] |
|**paginationKey** | **String** | Request ID of the last visit in the current page of results. Use this value in the following request as the `paginationKey` parameter to get the next page of results. | [optional] |



2 changes: 1 addition & 1 deletion docs/ResponseVisits.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**requestId** | **String** | Unique identifier of the user's identification request. | |
|**requestId** | **String** | Unique identifier of the user's identification request. | |
|**browserDetails** | [**BrowserDetails**](BrowserDetails.md) | | |
|**incognito** | **Boolean** | Flag if user used incognito session. | |
|**ip** | **String** | | |
Expand Down
2 changes: 1 addition & 1 deletion docs/SignalResponseEmulatorData.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**result** | **Boolean** | Android specific emulator detection. There are 2 values: • `true` - Emulated environment detected (e.g. launch inside of AVD) • `false` - No signs of emulated environment detected Available only for events from Android client. The field will not be present for a browser or iOS event. | [optional] |
|**result** | **Boolean** | Android specific emulator detection. There are 2 values: • `true` - Emulated environment detected (e.g. launch inside of AVD) • `false` - No signs of emulated environment detected Available only for events from Android client. The field will not be present for a browser or iOS event. | [optional] |



2 changes: 1 addition & 1 deletion docs/SignalResponseIncognitoData.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**result** | **Boolean** | `true` if we detected incognito mode used in the browser, `false` otherwise. | [optional] |
|**result** | **Boolean** | `true` if we detected incognito mode used in the browser, `false` otherwise. | [optional] |



2 changes: 1 addition & 1 deletion docs/SignalResponseProxyData.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**result** | **Boolean** | `true` if the request IP address is used by a public proxy provider, `false` otherwise. | [optional] |
|**result** | **Boolean** | `true` if the request IP address is used by a public proxy provider, `false` otherwise. | [optional] |



2 changes: 1 addition & 1 deletion docs/SignalResponseRootAppsData.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**result** | **Boolean** | Android specific root management apps detection. There are 2 values: • `true` - Root Management Apps detected (e.g. Magisk) • `false` - No Root Management Apps detected Available only for events from Android client. The field will not be present for a browser or iOS event. | [optional] |
|**result** | **Boolean** | Android specific root management apps detection. There are 2 values: • `true` - Root Management Apps detected (e.g. Magisk) • `false` - No Root Management Apps detected Available only for events from Android client. The field will not be present for a browser or iOS event. | [optional] |



2 changes: 1 addition & 1 deletion docs/SignalResponseTorData.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**result** | **Boolean** | `true` if the request IP address is a known tor exit node, `false` otherwise. | [optional] |
|**result** | **Boolean** | `true` if the request IP address is a known tor exit node, `false` otherwise. | [optional] |



2 changes: 1 addition & 1 deletion docs/TamperingResult.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**result** | **Boolean** | Flag indicating whether browser tampering was detected according to our internal thresholds. | [optional] |
|**anomalyScore** | [**BigDecimal**](BigDecimal.md) | Confidence score (`0.0 - 1.0`) for the tampering detection. Values above `0.5` suggest that we're reasonably sure there was a tampering attempt. Values below `0.5` are genuine browsers. | [optional] |
|**anomalyScore** | [**BigDecimal**](BigDecimal.md) | Confidence score (`0.0 - 1.0`) for the tampering detection. Values above `0.5` suggest that we're reasonably sure there was a tampering attempt. Values below `0.5` are genuine browsers. | [optional] |



2 changes: 1 addition & 1 deletion docs/Visit.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**requestId** | **String** | Unique identifier of the user's identification request. | |
|**requestId** | **String** | Unique identifier of the user's identification request. | |
|**browserDetails** | [**BrowserDetails**](BrowserDetails.md) | | |
|**incognito** | **Boolean** | Flag if user used incognito session. | |
|**ip** | **String** | | |
Expand Down
2 changes: 1 addition & 1 deletion docs/VpnResultMethods.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**timezoneMismatch** | **Boolean** | User's browser timezone doesn't match the timezone from which the request was originally made. | [optional] |
|**timezoneMismatch** | **Boolean** | User's browser timezone doesn't match the timezone from which the request was originally made. | [optional] |
|**publicVPN** | **Boolean** | Request IP address is owned and used by a public VPN service provider. | [optional] |


Expand Down
2 changes: 1 addition & 1 deletion docs/WebhookSignalResponseEmulator.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**result** | **Boolean** | Android specific emulator detection. There are 2 values: • `true` - Emulated environment detected (e.g. launch inside of AVD) • `false` - No signs of emulated environment detected Available only for events from Android client. The field will not be present for a browser or iOS event. | [optional] |
|**result** | **Boolean** | Android specific emulator detection. There are 2 values: • `true` - Emulated environment detected (e.g. launch inside of AVD) • `false` - No signs of emulated environment detected Available only for events from Android client. The field will not be present for a browser or iOS event. | [optional] |



2 changes: 1 addition & 1 deletion docs/WebhookSignalResponseProxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**result** | **Boolean** | `true` if the request IP address is used by a public proxy provider, `false` otherwise. | [optional] |
|**result** | **Boolean** | `true` if the request IP address is used by a public proxy provider, `false` otherwise. | [optional] |



2 changes: 1 addition & 1 deletion docs/WebhookSignalResponseRootApps.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**result** | **Boolean** | Android specific root management apps detection. There are 2 values: • `true` - Root Management Apps detected (e.g. Magisk) • `false` - No Root Management Apps detected Available only for events from Android client. The field will not be present for a browser or iOS event. | [optional] |
|**result** | **Boolean** | Android specific root management apps detection. There are 2 values: • `true` - Root Management Apps detected (e.g. Magisk) • `false` - No Root Management Apps detected Available only for events from Android client. The field will not be present for a browser or iOS event. | [optional] |



2 changes: 1 addition & 1 deletion docs/WebhookSignalResponseTor.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**result** | **Boolean** | `true` if the request IP address is a known tor exit node, `false` otherwise. | [optional] |
|**result** | **Boolean** | `true` if the request IP address is a known tor exit node, `false` otherwise. | [optional] |



2 changes: 1 addition & 1 deletion docs/WebhookVisit.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
|**vpn** | [**VpnResult**](VpnResult.md) | | [optional] |
|**proxy** | [**WebhookSignalResponseProxy**](WebhookSignalResponseProxy.md) | | [optional] |
|**tampering** | [**TamperingResult**](TamperingResult.md) | | [optional] |
|**requestId** | **String** | Unique identifier of the user's identification request. | |
|**requestId** | **String** | Unique identifier of the user's identification request. | |
|**browserDetails** | [**BrowserDetails**](BrowserDetails.md) | | |
|**ip** | **String** | | |
|**ipLocation** | [**IPLocation**](IPLocation.md) | | [optional] |
Expand Down
Loading

0 comments on commit 10ade24

Please sign in to comment.