-
Notifications
You must be signed in to change notification settings - Fork 143
Expand file tree
/
Copy pathclient.py
More file actions
230 lines (177 loc) · 6.92 KB
/
client.py
File metadata and controls
230 lines (177 loc) · 6.92 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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
# This file was auto-generated by Fern from our API Definition.
from __future__ import annotations
import typing
from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
from ..core.pagination import AsyncPager, SyncPager
from ..core.request_options import RequestOptions
from ..help_center.types.help_center import HelpCenter
from ..help_center.types.help_center_list import HelpCenterList
from .raw_client import AsyncRawHelpCentersClient, RawHelpCentersClient
if typing.TYPE_CHECKING:
from .collections.client import AsyncCollectionsClient, CollectionsClient
class HelpCentersClient:
def __init__(self, *, client_wrapper: SyncClientWrapper):
self._raw_client = RawHelpCentersClient(client_wrapper=client_wrapper)
self._client_wrapper = client_wrapper
self._collections: typing.Optional[CollectionsClient] = None
@property
def with_raw_response(self) -> RawHelpCentersClient:
"""
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
RawHelpCentersClient
"""
return self._raw_client
def find(self, help_center_id: int, *, request_options: typing.Optional[RequestOptions] = None) -> HelpCenter:
"""
You can fetch the details of a single Help Center by making a GET request to `https://api.intercom.io/help_center/help_center/<id>`.
Parameters
----------
help_center_id : int
The unique identifier for the collection which is given by Intercom.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
HelpCenter
Collection found
Examples
--------
from intercom import Intercom
client = Intercom(
token="YOUR_TOKEN",
)
client.help_centers.find(
help_center_id=1,
)
"""
_response = self._raw_client.find(help_center_id, request_options=request_options)
return _response.data
def list(
self,
*,
page: typing.Optional[int] = None,
per_page: typing.Optional[int] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> SyncPager[HelpCenter, HelpCenterList]:
"""
You can list all Help Centers by making a GET request to `https://api.intercom.io/help_center/help_centers`.
Parameters
----------
page : typing.Optional[int]
The page of results to fetch. Defaults to first page
per_page : typing.Optional[int]
How many results to display per page. Defaults to 15
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
SyncPager[HelpCenter, HelpCenterList]
Help Centers found
Examples
--------
from intercom import Intercom
client = Intercom(
token="YOUR_TOKEN",
)
response = client.help_centers.list()
for item in response:
yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
yield page
"""
return self._raw_client.list(page=page, per_page=per_page, request_options=request_options)
@property
def collections(self):
if self._collections is None:
from .collections.client import CollectionsClient # noqa: E402
self._collections = CollectionsClient(client_wrapper=self._client_wrapper)
return self._collections
class AsyncHelpCentersClient:
def __init__(self, *, client_wrapper: AsyncClientWrapper):
self._raw_client = AsyncRawHelpCentersClient(client_wrapper=client_wrapper)
self._client_wrapper = client_wrapper
self._collections: typing.Optional[AsyncCollectionsClient] = None
@property
def with_raw_response(self) -> AsyncRawHelpCentersClient:
"""
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
AsyncRawHelpCentersClient
"""
return self._raw_client
async def find(self, help_center_id: int, *, request_options: typing.Optional[RequestOptions] = None) -> HelpCenter:
"""
You can fetch the details of a single Help Center by making a GET request to `https://api.intercom.io/help_center/help_center/<id>`.
Parameters
----------
help_center_id : int
The unique identifier for the collection which is given by Intercom.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
HelpCenter
Collection found
Examples
--------
import asyncio
from intercom import AsyncIntercom
client = AsyncIntercom(
token="YOUR_TOKEN",
)
async def main() -> None:
await client.help_centers.find(
help_center_id=1,
)
asyncio.run(main())
"""
_response = await self._raw_client.find(help_center_id, request_options=request_options)
return _response.data
async def list(
self,
*,
page: typing.Optional[int] = None,
per_page: typing.Optional[int] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncPager[HelpCenter, HelpCenterList]:
"""
You can list all Help Centers by making a GET request to `https://api.intercom.io/help_center/help_centers`.
Parameters
----------
page : typing.Optional[int]
The page of results to fetch. Defaults to first page
per_page : typing.Optional[int]
How many results to display per page. Defaults to 15
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AsyncPager[HelpCenter, HelpCenterList]
Help Centers found
Examples
--------
import asyncio
from intercom import AsyncIntercom
client = AsyncIntercom(
token="YOUR_TOKEN",
)
async def main() -> None:
response = await client.help_centers.list()
async for item in response:
yield item
# alternatively, you can paginate page-by-page
async for page in response.iter_pages():
yield page
asyncio.run(main())
"""
return await self._raw_client.list(page=page, per_page=per_page, request_options=request_options)
@property
def collections(self):
if self._collections is None:
from .collections.client import AsyncCollectionsClient # noqa: E402
self._collections = AsyncCollectionsClient(client_wrapper=self._client_wrapper)
return self._collections