Skip to content

Commit c7667ca

Browse files
skamieniarzskamieniarz
authored
Merge pull request #150 from livechat/correct-wrong-surveys-report-to-forms
Correct `surveys` report to `forms` in reports-api v3.5 & v3.6
2 parents 2fb3f0a + 704e915 commit c7667ca

File tree

3 files changed

+34
-27
lines changed

3 files changed

+34
-27
lines changed

‎changelog.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ All notable changes to this project will be documented in this file.
66
### Added
77
- New `groups`, `queued_visitors`, `queued_visitors_left`, `unique_visitors` methods in reports-api v3.6.
88

9+
### Changed
10+
- Corrected the `surveys` report to `forms` in reports-api v3.5 & v3.6.
11+
912
## [0.4.0] - 2025-02-14
1013

1114
### Added

‎livechat/reports/api/v35.py

Lines changed: 23 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@
88
from livechat.utils.http_client import HttpClient
99
from livechat.utils.structures import AccessToken
1010

11+
# pylint: disable=unused-argument,too-many-arguments
12+
1113

1214
class ReportsApiV35(HttpClient):
1315
''' Reports API client class in version 3.5. '''
@@ -47,7 +49,7 @@ def duration(self,
4749
4850
Returns:
4951
httpx.Response: The Response object from `httpx` library,
50-
which contains a server’s response to an HTTP request.
52+
which contains a server's response to an HTTP request.
5153
'''
5254
if payload is None:
5355
payload = prepare_payload(locals())
@@ -77,7 +79,7 @@ def tags(self,
7779
7880
Returns:
7981
httpx.Response: The Response object from `httpx` library,
80-
which contains a server’s response to an HTTP request.
82+
which contains a server's response to an HTTP request.
8183
'''
8284
if payload is None:
8385
payload = prepare_payload(locals())
@@ -107,7 +109,7 @@ def total_chats(self,
107109
108110
Returns:
109111
httpx.Response: The Response object from `httpx` library,
110-
which contains a server’s response to an HTTP request.
112+
which contains a server's response to an HTTP request.
111113
'''
112114
if payload is None:
113115
payload = prepare_payload(locals())
@@ -137,7 +139,7 @@ def ratings(self,
137139
138140
Returns:
139141
httpx.Response: The Response object from `httpx` library,
140-
which contains a server’s response to an HTTP request.
142+
which contains a server's response to an HTTP request.
141143
'''
142144
if payload is None:
143145
payload = prepare_payload(locals())
@@ -167,7 +169,7 @@ def ranking(self,
167169
168170
Returns:
169171
httpx.Response: The Response object from `httpx` library,
170-
which contains a server’s response to an HTTP request.
172+
which contains a server's response to an HTTP request.
171173
'''
172174
if payload is None:
173175
payload = prepare_payload(locals())
@@ -197,7 +199,7 @@ def engagement(self,
197199
198200
Returns:
199201
httpx.Response: The Response object from `httpx` library,
200-
which contains a server’s response to an HTTP request.
202+
which contains a server's response to an HTTP request.
201203
'''
202204
if payload is None:
203205
payload = prepare_payload(locals())
@@ -227,20 +229,21 @@ def greetings_conversion(self,
227229
228230
Returns:
229231
httpx.Response: The Response object from `httpx` library,
230-
which contains a server’s response to an HTTP request.
232+
which contains a server's response to an HTTP request.
231233
'''
232234
if payload is None:
233235
payload = prepare_payload(locals())
234236
return self.session.post(f'{self.api_url}/chats/greetings_conversion',
235237
json=payload,
236238
headers=headers)
237239

238-
def surveys(self,
239-
timezone: str = None,
240-
filters: dict = None,
241-
payload: dict = None,
242-
headers: dict = None) -> httpx.Response:
243-
''' Returns the number of submitted chat surveys along with the count of specific answers.
240+
def forms(self,
241+
timezone: str = None,
242+
filters: dict = None,
243+
payload: dict = None,
244+
headers: dict = None) -> httpx.Response:
245+
''' Returns the number of submitted chat forms along with the count of specific answers.
246+
244247
245248
Args:
246249
timezone (str): IANA Time Zone (e.g. America/Phoenix).
@@ -255,11 +258,11 @@ def surveys(self,
255258
256259
Returns:
257260
httpx.Response: The Response object from `httpx` library,
258-
which contains a server’s response to an HTTP request.
261+
which contains a server's response to an HTTP request.
259262
'''
260263
if payload is None:
261264
payload = prepare_payload(locals())
262-
return self.session.post(f'{self.api_url}/chats/surveys',
265+
return self.session.post(f'{self.api_url}/chats/forms',
263266
json=payload,
264267
headers=headers)
265268

@@ -285,7 +288,7 @@ def response_time(self,
285288
286289
Returns:
287290
httpx.Response: The Response object from `httpx` library,
288-
which contains a server’s response to an HTTP request.
291+
which contains a server's response to an HTTP request.
289292
'''
290293
if payload is None:
291294
payload = prepare_payload(locals())
@@ -315,7 +318,7 @@ def first_response_time(self,
315318
316319
Returns:
317320
httpx.Response: The Response object from `httpx` library,
318-
which contains a server’s response to an HTTP request.
321+
which contains a server's response to an HTTP request.
319322
'''
320323
if payload is None:
321324
payload = prepare_payload(locals())
@@ -347,7 +350,7 @@ def availability(self,
347350
348351
Returns:
349352
httpx.Response: The Response object from `httpx` library,
350-
which contains a server’s response to an HTTP request.
353+
which contains a server's response to an HTTP request.
351354
'''
352355
if payload is None:
353356
payload = prepare_payload(locals())
@@ -377,7 +380,7 @@ def performance(self,
377380
378381
Returns:
379382
httpx.Response: The Response object from `httpx` library,
380-
which contains a server’s response to an HTTP request.
383+
which contains a server's response to an HTTP request.
381384
'''
382385
if payload is None:
383386
payload = prepare_payload(locals())
@@ -408,7 +411,7 @@ def chat_usage(self,
408411
409412
Returns:
410413
httpx.Response: The Response object from `httpx` library,
411-
which contains a server’s response to an HTTP request.
414+
which contains a server's response to an HTTP request.
412415
'''
413416
if payload is None:
414417
payload = prepare_payload(locals())

‎livechat/reports/api/v36.py

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -237,12 +237,13 @@ def greetings_conversion(self,
237237
json=payload,
238238
headers=headers)
239239

240-
def surveys(self,
241-
timezone: str = None,
242-
filters: dict = None,
243-
payload: dict = None,
244-
headers: dict = None) -> httpx.Response:
245-
''' Returns the number of submitted chat surveys along with the count of specific answers.
240+
def forms(self,
241+
timezone: str = None,
242+
filters: dict = None,
243+
payload: dict = None,
244+
headers: dict = None) -> httpx.Response:
245+
''' Returns the number of submitted chat forms along with the count of specific answers.
246+
246247
247248
Args:
248249
timezone (str): IANA Time Zone (e.g. America/Phoenix).
@@ -261,7 +262,7 @@ def surveys(self,
261262
'''
262263
if payload is None:
263264
payload = prepare_payload(locals())
264-
return self.session.post(f'{self.api_url}/chats/surveys',
265+
return self.session.post(f'{self.api_url}/chats/forms',
265266
json=payload,
266267
headers=headers)
267268

0 commit comments

Comments
 (0)