-
Notifications
You must be signed in to change notification settings - Fork 143
Expand file tree
/
Copy pathclient.py
More file actions
279 lines (209 loc) · 8.69 KB
/
client.py
File metadata and controls
279 lines (209 loc) · 8.69 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
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
# 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 AsyncRawMacrosClient, RawMacrosClient
from .types.macro import Macro
from .types.macro_list import MacroList
class MacrosClient:
def __init__(self, *, client_wrapper: SyncClientWrapper):
self._raw_client = RawMacrosClient(client_wrapper=client_wrapper)
@property
def with_raw_response(self) -> RawMacrosClient:
"""
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
RawMacrosClient
"""
return self._raw_client
def list_macros(
self,
*,
per_page: typing.Optional[int] = None,
starting_after: typing.Optional[str] = None,
updated_since: typing.Optional[int] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> MacroList:
"""
You can fetch a list of all macros (saved replies) in your workspace for use in automating responses.
The macros are returned in descending order by updated_at.
**Pagination**
This endpoint uses cursor-based pagination via the `starting_after` parameter. The cursor is a Base64-encoded JSON array containing `[updated_at, id]` of the last item from the previous page.
**Placeholder Transformation**
The API transforms Intercom placeholders to a more standard XML-like format:
- From: `{{user.name | fallback: 'there'}}`
- To: `<attribute key="user.name" default="there"/>`
Parameters
----------
per_page : typing.Optional[int]
The number of results per page
starting_after : typing.Optional[str]
Base64-encoded cursor containing [updated_at, id] for pagination
updated_since : typing.Optional[int]
Unix timestamp to filter macros updated after this time
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
MacroList
Successful response
Examples
--------
from intercom import Intercom
client = Intercom(
token="YOUR_TOKEN",
)
client.unstable.macros.list_macros(
per_page=1,
starting_after="WzE3MTk0OTM3NTcuMCwgIjEyMyJd",
updated_since=1000000,
)
"""
_response = self._raw_client.list_macros(
per_page=per_page,
starting_after=starting_after,
updated_since=updated_since,
request_options=request_options,
)
return _response.data
def get_macro(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> typing.Optional[Macro]:
"""
You can fetch a single macro (saved reply) by its ID. The macro will only be returned if it is visible to the authenticated user based on its visibility settings.
**Visibility Rules**
A macro is returned based on its `visible_to` setting:
- `everyone`: Always visible to all team members
- `specific_teams`: Only visible if the authenticated user belongs to one of the teams specified in `visible_to_team_ids`
If a macro exists but is not visible to the authenticated user, a 404 error is returned.
**Placeholder Transformation**
The API transforms Intercom placeholders to a more standard XML-like format in the `body` field:
- From: `{{user.name | fallback: 'there'}}`
- To: `<attribute key="user.name" default="there"/>`
Default values in placeholders are HTML-escaped for security.
Parameters
----------
id : str
The unique identifier of the macro
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
typing.Optional[Macro]
Macro found
Examples
--------
from intercom import Intercom
client = Intercom(
token="YOUR_TOKEN",
)
client.unstable.macros.get_macro(
id="123",
)
"""
_response = self._raw_client.get_macro(id, request_options=request_options)
return _response.data
class AsyncMacrosClient:
def __init__(self, *, client_wrapper: AsyncClientWrapper):
self._raw_client = AsyncRawMacrosClient(client_wrapper=client_wrapper)
@property
def with_raw_response(self) -> AsyncRawMacrosClient:
"""
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
AsyncRawMacrosClient
"""
return self._raw_client
async def list_macros(
self,
*,
per_page: typing.Optional[int] = None,
starting_after: typing.Optional[str] = None,
updated_since: typing.Optional[int] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> MacroList:
"""
You can fetch a list of all macros (saved replies) in your workspace for use in automating responses.
The macros are returned in descending order by updated_at.
**Pagination**
This endpoint uses cursor-based pagination via the `starting_after` parameter. The cursor is a Base64-encoded JSON array containing `[updated_at, id]` of the last item from the previous page.
**Placeholder Transformation**
The API transforms Intercom placeholders to a more standard XML-like format:
- From: `{{user.name | fallback: 'there'}}`
- To: `<attribute key="user.name" default="there"/>`
Parameters
----------
per_page : typing.Optional[int]
The number of results per page
starting_after : typing.Optional[str]
Base64-encoded cursor containing [updated_at, id] for pagination
updated_since : typing.Optional[int]
Unix timestamp to filter macros updated after this time
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
MacroList
Successful response
Examples
--------
import asyncio
from intercom import AsyncIntercom
client = AsyncIntercom(
token="YOUR_TOKEN",
)
async def main() -> None:
await client.unstable.macros.list_macros(
per_page=1,
starting_after="WzE3MTk0OTM3NTcuMCwgIjEyMyJd",
updated_since=1000000,
)
asyncio.run(main())
"""
_response = await self._raw_client.list_macros(
per_page=per_page,
starting_after=starting_after,
updated_since=updated_since,
request_options=request_options,
)
return _response.data
async def get_macro(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> typing.Optional[Macro]:
"""
You can fetch a single macro (saved reply) by its ID. The macro will only be returned if it is visible to the authenticated user based on its visibility settings.
**Visibility Rules**
A macro is returned based on its `visible_to` setting:
- `everyone`: Always visible to all team members
- `specific_teams`: Only visible if the authenticated user belongs to one of the teams specified in `visible_to_team_ids`
If a macro exists but is not visible to the authenticated user, a 404 error is returned.
**Placeholder Transformation**
The API transforms Intercom placeholders to a more standard XML-like format in the `body` field:
- From: `{{user.name | fallback: 'there'}}`
- To: `<attribute key="user.name" default="there"/>`
Default values in placeholders are HTML-escaped for security.
Parameters
----------
id : str
The unique identifier of the macro
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
typing.Optional[Macro]
Macro found
Examples
--------
import asyncio
from intercom import AsyncIntercom
client = AsyncIntercom(
token="YOUR_TOKEN",
)
async def main() -> None:
await client.unstable.macros.get_macro(
id="123",
)
asyncio.run(main())
"""
_response = await self._raw_client.get_macro(id, request_options=request_options)
return _response.data