Skip to content

Commit 1719ed4

Browse files
committed
docs: fix documentation and examples
1 parent 04a00a5 commit 1719ed4

File tree

5 files changed

+14
-19
lines changed

5 files changed

+14
-19
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -152,20 +152,20 @@ except ApiException as e:
152152
Update event for requestId:
153153
```python
154154
import fingerprint_pro_server_api_sdk
155-
from fingerprint_pro_server_api_sdk import EventUpdateRequest
155+
from fingerprint_pro_server_api_sdk import EventsUpdateRequest
156156
from fingerprint_pro_server_api_sdk.rest import ApiException, KnownApiException
157157

158158
configuration = fingerprint_pro_server_api_sdk.Configuration(api_key="SECRET_API_KEY")
159159
api_instance = fingerprint_pro_server_api_sdk.FingerprintApi(configuration)
160160

161161
request_id = 'request_id_example' # str | The unique event [identifier](https://dev.fingerprint.com/docs/js-agent#requestid).
162-
body = EventUpdateRequest(linked_id='foo') # EventUpdateRequest |
163-
# body = EventUpdateRequest(tag={'bar': 123})
164-
# body = EventUpdateRequest(suspect=True)
165-
# body = EventUpdateRequest(linked_id='foo', tag={'bar': 123}, suspect=False)
162+
body = EventsUpdateRequest(linked_id='foo') # EventsUpdateRequest |
163+
# body = EventsUpdateRequest(tag={'bar': 123})
164+
# body = EventsUpdateRequest(suspect=True)
165+
# body = EventsUpdateRequest(linked_id='foo', tag={'bar': 123}, suspect=False)
166166

167167
try:
168-
api_instance.update_event(request_id, body)
168+
api_instance.update_event(body, request_id)
169169
except KnownApiException as e:
170170
structured_error = e.structured_error
171171
print("Error code: %s. Error message: %s\n" % (structured_error.error.code, structured_error.error.message))

docs/FingerprintApi.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ Request deleting all data associated with the specified visitor ID. This API is
1919
### Example
2020
```python
2121
import fingerprint_pro_server_api_sdk
22-
from fingerprint_pro_server_api_sdk import Response
2322
from fingerprint_pro_server_api_sdk.rest import ApiException
2423

2524
# Configure API key authorization and region
@@ -69,7 +68,6 @@ Get a detailed analysis of an individual identification event, including Smart S
6968
### Example
7069
```python
7170
import fingerprint_pro_server_api_sdk
72-
from fingerprint_pro_server_api_sdk import Response
7371
from fingerprint_pro_server_api_sdk.rest import ApiException
7472

7573
# Configure API key authorization and region
@@ -120,7 +118,6 @@ Get a history of visits (identification events) for a specific `visitorId`. Use
120118
### Example
121119
```python
122120
import fingerprint_pro_server_api_sdk
123-
from fingerprint_pro_server_api_sdk import Response
124121
from fingerprint_pro_server_api_sdk.rest import ApiException
125122

126123
# Configure API key authorization and region
@@ -181,7 +178,6 @@ Change information in existing events specified by `requestId` or *flag suspicio
181178
### Example
182179
```python
183180
import fingerprint_pro_server_api_sdk
184-
from fingerprint_pro_server_api_sdk import Response
185181
from fingerprint_pro_server_api_sdk.rest import ApiException
186182

187183
# Configure API key authorization and region

template/README.mustache

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -158,20 +158,20 @@ except ApiException as e:
158158
Update event for requestId:
159159
```python
160160
import {{packageName}}
161-
from {{packageName}} import EventUpdateRequest
161+
from {{packageName}} import EventsUpdateRequest
162162
from {{packageName}}.rest import ApiException, KnownApiException
163163

164164
configuration = {{packageName}}.Configuration(api_key="SECRET_API_KEY")
165165
api_instance = {{packageName}}.FingerprintApi(configuration)
166166

167167
request_id = 'request_id_example' # str | The unique event [identifier](https://dev.fingerprint.com/docs/js-agent#requestid).
168-
body = EventUpdateRequest(linked_id='foo') # EventUpdateRequest |
169-
# body = EventUpdateRequest(tag={'bar': 123})
170-
# body = EventUpdateRequest(suspect=True)
171-
# body = EventUpdateRequest(linked_id='foo', tag={'bar': 123}, suspect=False)
168+
body = EventsUpdateRequest(linked_id='foo') # EventsUpdateRequest |
169+
# body = EventsUpdateRequest(tag={'bar': 123})
170+
# body = EventsUpdateRequest(suspect=True)
171+
# body = EventsUpdateRequest(linked_id='foo', tag={'bar': 123}, suspect=False)
172172

173173
try:
174-
api_instance.update_event(request_id, body)
174+
api_instance.update_event(body, request_id)
175175
except KnownApiException as e:
176176
structured_error = e.structured_error
177177
print("Error code: %s. Error message: %s\n" % (structured_error.error.code, structured_error.error.message))

template/api_doc.mustache

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ Method | HTTP request | Description
2020
### Example
2121
```python
2222
import {{{packageName}}}
23-
from {{{packageName}}} import Response
2423
from {{{packageName}}}.rest import ApiException
2524

2625
# Configure API key authorization and region

update_event_example.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
import fingerprint_pro_server_api_sdk
55
from fingerprint_pro_server_api_sdk.rest import ApiException
6-
from fingerprint_pro_server_api_sdk.models import EventUpdateRequest
6+
from fingerprint_pro_server_api_sdk.models import EventsUpdateRequest
77

88
from dotenv import load_dotenv
99

@@ -25,7 +25,7 @@
2525
request_id = os.environ["REQUEST_ID_TO_UPDATE"]
2626

2727
try:
28-
updateBody = EventUpdateRequest(**vars(args))
28+
updateBody = EventsUpdateRequest(**vars(args))
2929
print(f'updateBody: {updateBody}')
3030
api_instance.update_event(updateBody, request_id)
3131
except ApiException as e:

0 commit comments

Comments
 (0)