diff --git a/docs/IPLocation.md b/docs/IPLocation.md index 5fc4bd38..73e6458c 100644 --- a/docs/IPLocation.md +++ b/docs/IPLocation.md @@ -1,4 +1,6 @@ # IPLocation +This field is **deprecated** and will not return a result for **accounts created after December 18th, 2023**. Please use the [`ipInfo` Smart signal](https://dev.fingerprint.com/docs/smart-signals-overview#ip-geolocation) for geolocation information. + ## Properties Name | Type | Description | Notes diff --git a/docs/IpInfoResultV4.md b/docs/IpInfoResultV4.md index c08f44eb..0ff48b16 100644 --- a/docs/IpInfoResultV4.md +++ b/docs/IpInfoResultV4.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes **address** | **str** | | [optional] **geolocation** | [**IPLocation**](IPLocation.md) | | [optional] **asn** | [**ASN**](ASN.md) | | [optional] -**data_center** | [**DataCenter**](DataCenter.md) | | [optional] +**datacenter** | [**DataCenter**](DataCenter.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/IpInfoResultV6.md b/docs/IpInfoResultV6.md index 76721965..8bed1402 100644 --- a/docs/IpInfoResultV6.md +++ b/docs/IpInfoResultV6.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes **address** | **str** | | [optional] **geolocation** | [**IPLocation**](IPLocation.md) | | [optional] **asn** | [**ASN**](ASN.md) | | [optional] -**data_center** | [**DataCenter**](DataCenter.md) | | [optional] +**datacenter** | [**DataCenter**](DataCenter.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/fingerprint_pro_server_api_sdk/models/botd_detection_result.py b/fingerprint_pro_server_api_sdk/models/botd_detection_result.py index 77a7c0cf..da06dc89 100644 --- a/fingerprint_pro_server_api_sdk/models/botd_detection_result.py +++ b/fingerprint_pro_server_api_sdk/models/botd_detection_result.py @@ -16,7 +16,10 @@ import six class BotdDetectionResult(object): - """NOTE: This class is auto generated by the swagger code generator program. + """ + Stores bot detection result + + NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. """ diff --git a/fingerprint_pro_server_api_sdk/models/botd_result.py b/fingerprint_pro_server_api_sdk/models/botd_result.py index 5d9550ee..3e78c750 100644 --- a/fingerprint_pro_server_api_sdk/models/botd_result.py +++ b/fingerprint_pro_server_api_sdk/models/botd_result.py @@ -16,7 +16,10 @@ import six class BotdResult(object): - """NOTE: This class is auto generated by the swagger code generator program. + """ + Contains all the information from Bot Detection product + + NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. """ diff --git a/fingerprint_pro_server_api_sdk/models/event_response.py b/fingerprint_pro_server_api_sdk/models/event_response.py index 38cfbd70..1df65b80 100644 --- a/fingerprint_pro_server_api_sdk/models/event_response.py +++ b/fingerprint_pro_server_api_sdk/models/event_response.py @@ -16,7 +16,10 @@ import six class EventResponse(object): - """NOTE: This class is auto generated by the swagger code generator program. + """ + Contains results from all activated products - Fingerprint Pro, Bot Detection, and others. + + NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. """ diff --git a/fingerprint_pro_server_api_sdk/models/ip_info_result.py b/fingerprint_pro_server_api_sdk/models/ip_info_result.py index fad894eb..0fa494e9 100644 --- a/fingerprint_pro_server_api_sdk/models/ip_info_result.py +++ b/fingerprint_pro_server_api_sdk/models/ip_info_result.py @@ -16,7 +16,10 @@ import six class IpInfoResult(object): - """NOTE: This class is auto generated by the swagger code generator program. + """ + Details about the request IP address. Has separate fields for v4 and v6 IP address versions. + + NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. """ diff --git a/fingerprint_pro_server_api_sdk/models/ip_info_result_v4.py b/fingerprint_pro_server_api_sdk/models/ip_info_result_v4.py index c8827340..bbee6ae3 100644 --- a/fingerprint_pro_server_api_sdk/models/ip_info_result_v4.py +++ b/fingerprint_pro_server_api_sdk/models/ip_info_result_v4.py @@ -31,22 +31,22 @@ class IpInfoResultV4(object): 'address': 'str', 'geolocation': 'IPLocation', 'asn': 'ASN', - 'data_center': 'DataCenter' + 'datacenter': 'DataCenter' } attribute_map = { 'address': 'address', 'geolocation': 'geolocation', 'asn': 'asn', - 'data_center': 'dataCenter' + 'datacenter': 'datacenter' } - def __init__(self, address=None, geolocation=None, asn=None, data_center=None): # noqa: E501 + def __init__(self, address=None, geolocation=None, asn=None, datacenter=None): # noqa: E501 """IpInfoResultV4 - a model defined in Swagger""" # noqa: E501 self._address = None self._geolocation = None self._asn = None - self._data_center = None + self._datacenter = None self.discriminator = None if address is not None: self.address = address @@ -54,8 +54,8 @@ def __init__(self, address=None, geolocation=None, asn=None, data_center=None): self.geolocation = geolocation if asn is not None: self.asn = asn - if data_center is not None: - self.data_center = data_center + if datacenter is not None: + self.datacenter = datacenter @property def address(self): @@ -121,25 +121,25 @@ def asn(self, asn): self._asn = asn @property - def data_center(self): - """Gets the data_center of this IpInfoResultV4. # noqa: E501 + def datacenter(self): + """Gets the datacenter of this IpInfoResultV4. # noqa: E501 - :return: The data_center of this IpInfoResultV4. # noqa: E501 + :return: The datacenter of this IpInfoResultV4. # noqa: E501 :rtype: DataCenter """ - return self._data_center + return self._datacenter - @data_center.setter - def data_center(self, data_center): - """Sets the data_center of this IpInfoResultV4. + @datacenter.setter + def datacenter(self, datacenter): + """Sets the datacenter of this IpInfoResultV4. - :param data_center: The data_center of this IpInfoResultV4. # noqa: E501 + :param datacenter: The datacenter of this IpInfoResultV4. # noqa: E501 :type: DataCenter """ - self._data_center = data_center + self._datacenter = datacenter def to_dict(self): """Returns the model properties as a dict""" diff --git a/fingerprint_pro_server_api_sdk/models/ip_info_result_v6.py b/fingerprint_pro_server_api_sdk/models/ip_info_result_v6.py index f384a2d5..a039f9f0 100644 --- a/fingerprint_pro_server_api_sdk/models/ip_info_result_v6.py +++ b/fingerprint_pro_server_api_sdk/models/ip_info_result_v6.py @@ -31,22 +31,22 @@ class IpInfoResultV6(object): 'address': 'str', 'geolocation': 'IPLocation', 'asn': 'ASN', - 'data_center': 'DataCenter' + 'datacenter': 'DataCenter' } attribute_map = { 'address': 'address', 'geolocation': 'geolocation', 'asn': 'asn', - 'data_center': 'dataCenter' + 'datacenter': 'datacenter' } - def __init__(self, address=None, geolocation=None, asn=None, data_center=None): # noqa: E501 + def __init__(self, address=None, geolocation=None, asn=None, datacenter=None): # noqa: E501 """IpInfoResultV6 - a model defined in Swagger""" # noqa: E501 self._address = None self._geolocation = None self._asn = None - self._data_center = None + self._datacenter = None self.discriminator = None if address is not None: self.address = address @@ -54,8 +54,8 @@ def __init__(self, address=None, geolocation=None, asn=None, data_center=None): self.geolocation = geolocation if asn is not None: self.asn = asn - if data_center is not None: - self.data_center = data_center + if datacenter is not None: + self.datacenter = datacenter @property def address(self): @@ -121,25 +121,25 @@ def asn(self, asn): self._asn = asn @property - def data_center(self): - """Gets the data_center of this IpInfoResultV6. # noqa: E501 + def datacenter(self): + """Gets the datacenter of this IpInfoResultV6. # noqa: E501 - :return: The data_center of this IpInfoResultV6. # noqa: E501 + :return: The datacenter of this IpInfoResultV6. # noqa: E501 :rtype: DataCenter """ - return self._data_center + return self._datacenter - @data_center.setter - def data_center(self, data_center): - """Sets the data_center of this IpInfoResultV6. + @datacenter.setter + def datacenter(self, datacenter): + """Sets the datacenter of this IpInfoResultV6. - :param data_center: The data_center of this IpInfoResultV6. # noqa: E501 + :param datacenter: The datacenter of this IpInfoResultV6. # noqa: E501 :type: DataCenter """ - self._data_center = data_center + self._datacenter = datacenter def to_dict(self): """Returns the model properties as a dict""" diff --git a/fingerprint_pro_server_api_sdk/models/ip_location.py b/fingerprint_pro_server_api_sdk/models/ip_location.py index fc5710f4..4a0d2a95 100644 --- a/fingerprint_pro_server_api_sdk/models/ip_location.py +++ b/fingerprint_pro_server_api_sdk/models/ip_location.py @@ -16,7 +16,10 @@ import six class IPLocation(object): - """NOTE: This class is auto generated by the swagger code generator program. + """ + This field is **deprecated** and will not return a result for **accounts created after December 18th, 2023**. Please use the [`ipInfo` Smart signal](https://dev.fingerprint.com/docs/smart-signals-overview#ip-geolocation) for geolocation information. + + NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. """ diff --git a/fingerprint_pro_server_api_sdk/models/products_response.py b/fingerprint_pro_server_api_sdk/models/products_response.py index 1440a34a..ab325ee6 100644 --- a/fingerprint_pro_server_api_sdk/models/products_response.py +++ b/fingerprint_pro_server_api_sdk/models/products_response.py @@ -16,7 +16,10 @@ import six class ProductsResponse(object): - """NOTE: This class is auto generated by the swagger code generator program. + """ + Contains all information about the request identified by `requestId`, depending on the pricing plan (Pro, Pro Plus, Enterprise) + + NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. """ diff --git a/fingerprint_pro_server_api_sdk/models/raw_device_attributes_result.py b/fingerprint_pro_server_api_sdk/models/raw_device_attributes_result.py index 9b6f5551..09f72765 100644 --- a/fingerprint_pro_server_api_sdk/models/raw_device_attributes_result.py +++ b/fingerprint_pro_server_api_sdk/models/raw_device_attributes_result.py @@ -16,7 +16,10 @@ import six class RawDeviceAttributesResult(object): - """NOTE: This class is auto generated by the swagger code generator program. + """ + It includes 35+ raw browser identification attributes to provide Fingerprint users with even more information than our standard visitor ID provides. This enables Fingerprint users to not have to run our open-source product in conjunction with Fingerprint Pro Plus and Enterprise to get those additional attributes. Warning: The raw signals data can change at any moment as we improve the product. We cannot guarantee the internal shape of raw device attributes to be stable, so typical semantic versioning rules do not apply here. Use this data with caution without assuming a specific structure beyond the generic type provided here. + + NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. """ diff --git a/fingerprint_pro_server_api_sdk/models/response.py b/fingerprint_pro_server_api_sdk/models/response.py index 3d426791..5d01f962 100644 --- a/fingerprint_pro_server_api_sdk/models/response.py +++ b/fingerprint_pro_server_api_sdk/models/response.py @@ -16,7 +16,10 @@ import six class Response(object): - """NOTE: This class is auto generated by the swagger code generator program. + """ + Fields `lastTimestamp` and `paginationKey` added when `limit` or `before` parameter provided and there is more data to show + + NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. """ diff --git a/res/fingerprint-server-api.yaml b/res/fingerprint-server-api.yaml index d5a61a28..da9215cd 100644 --- a/res/fingerprint-server-api.yaml +++ b/res/fingerprint-server-api.yaml @@ -158,7 +158,7 @@ paths: asn: '7922' name: COMCAST-7922 network: 73.136.0.0/13 - dataCenter: + datacenter: result: true name: DediPath incognito: @@ -3701,7 +3701,7 @@ paths: asn: '7922' name: COMCAST-7922 network: 73.136.0.0/13 - dataCenter: + datacenter: result: true name: DediPath rootApps: @@ -4335,6 +4335,12 @@ components: IPLocation: type: object additionalProperties: false + deprecated: true + description: >- + This field is **deprecated** and will not return a result for **accounts + created after December 18th, 2023**. Please use the [`ipInfo` Smart + signal](https://dev.fingerprint.com/docs/smart-signals-overview#ip-geolocation) + for geolocation information. properties: accuracyRadius: description: >- @@ -4857,7 +4863,7 @@ components: $ref: '#/components/schemas/IPLocation' asn: $ref: '#/components/schemas/ASN' - dataCenter: + datacenter: $ref: '#/components/schemas/DataCenter' v6: type: object @@ -4871,7 +4877,7 @@ components: $ref: '#/components/schemas/IPLocation' asn: $ref: '#/components/schemas/ASN' - dataCenter: + datacenter: $ref: '#/components/schemas/DataCenter' IpBlockListResult: type: object diff --git a/template/model.mustache b/template/model.mustache index fd52e6c7..0be26d6a 100644 --- a/template/model.mustache +++ b/template/model.mustache @@ -10,7 +10,10 @@ import six {{#models}} {{#model}} class {{classname}}(object): - """NOTE: This class is auto generated by the swagger code generator program. + """{{#description}} + {{{.}}} + + {{/description}}NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. """{{#allowableValues}} diff --git a/test/mocks/get_event.json b/test/mocks/get_event.json index 0a89f7d4..808f12f4 100644 --- a/test/mocks/get_event.json +++ b/test/mocks/get_event.json @@ -100,7 +100,7 @@ "name": "COMCAST-7922", "network": "73.136.0.0/13" }, - "dataCenter": { + "datacenter": { "result": true, "name": "DediPath" } @@ -229,4 +229,4 @@ } } } -} \ No newline at end of file +} diff --git a/test/mocks/webhook.json b/test/mocks/webhook.json index 9ae35fa0..9ba70238 100644 --- a/test/mocks/webhook.json +++ b/test/mocks/webhook.json @@ -94,7 +94,7 @@ "name": "COMCAST-7922", "network": "73.136.0.0/13" }, - "dataCenter": { + "datacenter": { "result": true, "name": "DediPath" } @@ -184,4 +184,4 @@ "locationSpoofing": { "result": true } -} \ No newline at end of file +}