-
Notifications
You must be signed in to change notification settings - Fork 143
Expand file tree
/
Copy pathclient.py
More file actions
214 lines (169 loc) · 5.97 KB
/
client.py
File metadata and controls
214 lines (169 loc) · 5.97 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
# This file was auto-generated by Fern from our API Definition.
import typing
from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
from ..core.request_options import RequestOptions
from .raw_client import AsyncRawExportClient, RawExportClient
from .types.get_export_reporting_data_get_datasets_response import GetExportReportingDataGetDatasetsResponse
from .types.post_export_reporting_data_enqueue_response import PostExportReportingDataEnqueueResponse
# this is used as the default value for optional parameters
OMIT = typing.cast(typing.Any, ...)
class ExportClient:
def __init__(self, *, client_wrapper: SyncClientWrapper):
self._raw_client = RawExportClient(client_wrapper=client_wrapper)
@property
def with_raw_response(self) -> RawExportClient:
"""
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
RawExportClient
"""
return self._raw_client
def enqueue_a_new_reporting_data_export_job(
self,
*,
dataset_id: str,
attribute_ids: typing.Sequence[str],
start_time: int,
end_time: int,
request_options: typing.Optional[RequestOptions] = None,
) -> PostExportReportingDataEnqueueResponse:
"""
Parameters
----------
dataset_id : str
attribute_ids : typing.Sequence[str]
start_time : int
end_time : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
PostExportReportingDataEnqueueResponse
Job enqueued successfully
Examples
--------
from intercom import Intercom
client = Intercom(
token="YOUR_TOKEN",
)
client.export.enqueue_a_new_reporting_data_export_job(
dataset_id="conversation",
attribute_ids=["conversation_id", "conversation_started_at"],
start_time=1717490000,
end_time=1717510000,
)
"""
_response = self._raw_client.enqueue_a_new_reporting_data_export_job(
dataset_id=dataset_id,
attribute_ids=attribute_ids,
start_time=start_time,
end_time=end_time,
request_options=request_options,
)
return _response.data
def list_available_datasets_and_attributes(
self, *, request_options: typing.Optional[RequestOptions] = None
) -> GetExportReportingDataGetDatasetsResponse:
"""
Parameters
----------
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
GetExportReportingDataGetDatasetsResponse
List of datasets
Examples
--------
from intercom import Intercom
client = Intercom(
token="YOUR_TOKEN",
)
client.export.list_available_datasets_and_attributes()
"""
_response = self._raw_client.list_available_datasets_and_attributes(request_options=request_options)
return _response.data
class AsyncExportClient:
def __init__(self, *, client_wrapper: AsyncClientWrapper):
self._raw_client = AsyncRawExportClient(client_wrapper=client_wrapper)
@property
def with_raw_response(self) -> AsyncRawExportClient:
"""
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
AsyncRawExportClient
"""
return self._raw_client
async def enqueue_a_new_reporting_data_export_job(
self,
*,
dataset_id: str,
attribute_ids: typing.Sequence[str],
start_time: int,
end_time: int,
request_options: typing.Optional[RequestOptions] = None,
) -> PostExportReportingDataEnqueueResponse:
"""
Parameters
----------
dataset_id : str
attribute_ids : typing.Sequence[str]
start_time : int
end_time : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
PostExportReportingDataEnqueueResponse
Job enqueued successfully
Examples
--------
import asyncio
from intercom import AsyncIntercom
client = AsyncIntercom(
token="YOUR_TOKEN",
)
async def main() -> None:
await client.export.enqueue_a_new_reporting_data_export_job(
dataset_id="conversation",
attribute_ids=["conversation_id", "conversation_started_at"],
start_time=1717490000,
end_time=1717510000,
)
asyncio.run(main())
"""
_response = await self._raw_client.enqueue_a_new_reporting_data_export_job(
dataset_id=dataset_id,
attribute_ids=attribute_ids,
start_time=start_time,
end_time=end_time,
request_options=request_options,
)
return _response.data
async def list_available_datasets_and_attributes(
self, *, request_options: typing.Optional[RequestOptions] = None
) -> GetExportReportingDataGetDatasetsResponse:
"""
Parameters
----------
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
GetExportReportingDataGetDatasetsResponse
List of datasets
Examples
--------
import asyncio
from intercom import AsyncIntercom
client = AsyncIntercom(
token="YOUR_TOKEN",
)
async def main() -> None:
await client.export.list_available_datasets_and_attributes()
asyncio.run(main())
"""
_response = await self._raw_client.list_available_datasets_and_attributes(request_options=request_options)
return _response.data