-
Notifications
You must be signed in to change notification settings - Fork 143
Expand file tree
/
Copy pathtags.py
More file actions
388 lines (331 loc) · 12.3 KB
/
tags.py
File metadata and controls
388 lines (331 loc) · 12.3 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
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
from __future__ import annotations
from typing_extensions import Literal
import httpx
from ..._types import NOT_GIVEN, Body, Query, Headers, NotGiven
from ..._utils import (
is_given,
maybe_transform,
strip_not_given,
async_maybe_transform,
)
from ..._compat import cached_property
from ..._resource import SyncAPIResource, AsyncAPIResource
from ..._response import (
to_raw_response_wrapper,
to_streamed_response_wrapper,
async_to_raw_response_wrapper,
async_to_streamed_response_wrapper,
)
from ..._base_client import make_request_options
from ...types.tickets import tag_create_params, tag_remove_params
from ...types.shared.tag import Tag
__all__ = ["TagsResource", "AsyncTagsResource"]
class TagsResource(SyncAPIResource):
@cached_property
def with_raw_response(self) -> TagsResourceWithRawResponse:
return TagsResourceWithRawResponse(self)
@cached_property
def with_streaming_response(self) -> TagsResourceWithStreamingResponse:
return TagsResourceWithStreamingResponse(self)
def create(
self,
ticket_id: str,
*,
id: str,
admin_id: str,
intercom_version: Literal[
"1.0",
"1.1",
"1.2",
"1.3",
"1.4",
"2.0",
"2.1",
"2.2",
"2.3",
"2.4",
"2.5",
"2.6",
"2.7",
"2.8",
"2.9",
"2.10",
"2.11",
"Unstable",
]
| NotGiven = NOT_GIVEN,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) -> Tag:
"""You can tag a specific ticket.
This will return a tag object for the tag that
was added to the ticket.
Args:
id: The unique identifier for the tag which is given by Intercom
admin_id: The unique identifier for the admin which is given by Intercom.
intercom_version: Intercom API version.By default, it's equal to the version set in the app
package.
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
if not ticket_id:
raise ValueError(f"Expected a non-empty value for `ticket_id` but received {ticket_id!r}")
extra_headers = {
**strip_not_given({"Intercom-Version": str(intercom_version) if is_given(intercom_version) else NOT_GIVEN}),
**(extra_headers or {}),
}
return self._post(
f"/tickets/{ticket_id}/tags",
body=maybe_transform(
{
"id": id,
"admin_id": admin_id,
},
tag_create_params.TagCreateParams,
),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=Tag,
)
def remove(
self,
id: str,
*,
ticket_id: str,
admin_id: str,
intercom_version: Literal[
"1.0",
"1.1",
"1.2",
"1.3",
"1.4",
"2.0",
"2.1",
"2.2",
"2.3",
"2.4",
"2.5",
"2.6",
"2.7",
"2.8",
"2.9",
"2.10",
"2.11",
"Unstable",
]
| NotGiven = NOT_GIVEN,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) -> Tag:
"""You can remove tag from a specific ticket.
This will return a tag object for the
tag that was removed from the ticket.
Args:
admin_id: The unique identifier for the admin which is given by Intercom.
intercom_version: Intercom API version.By default, it's equal to the version set in the app
package.
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
if not ticket_id:
raise ValueError(f"Expected a non-empty value for `ticket_id` but received {ticket_id!r}")
if not id:
raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
extra_headers = {
**strip_not_given({"Intercom-Version": str(intercom_version) if is_given(intercom_version) else NOT_GIVEN}),
**(extra_headers or {}),
}
return self._delete(
f"/tickets/{ticket_id}/tags/{id}",
body=maybe_transform({"admin_id": admin_id}, tag_remove_params.TagRemoveParams),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=Tag,
)
class AsyncTagsResource(AsyncAPIResource):
@cached_property
def with_raw_response(self) -> AsyncTagsResourceWithRawResponse:
return AsyncTagsResourceWithRawResponse(self)
@cached_property
def with_streaming_response(self) -> AsyncTagsResourceWithStreamingResponse:
return AsyncTagsResourceWithStreamingResponse(self)
async def create(
self,
ticket_id: str,
*,
id: str,
admin_id: str,
intercom_version: Literal[
"1.0",
"1.1",
"1.2",
"1.3",
"1.4",
"2.0",
"2.1",
"2.2",
"2.3",
"2.4",
"2.5",
"2.6",
"2.7",
"2.8",
"2.9",
"2.10",
"2.11",
"Unstable",
]
| NotGiven = NOT_GIVEN,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) -> Tag:
"""You can tag a specific ticket.
This will return a tag object for the tag that
was added to the ticket.
Args:
id: The unique identifier for the tag which is given by Intercom
admin_id: The unique identifier for the admin which is given by Intercom.
intercom_version: Intercom API version.By default, it's equal to the version set in the app
package.
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
if not ticket_id:
raise ValueError(f"Expected a non-empty value for `ticket_id` but received {ticket_id!r}")
extra_headers = {
**strip_not_given({"Intercom-Version": str(intercom_version) if is_given(intercom_version) else NOT_GIVEN}),
**(extra_headers or {}),
}
return await self._post(
f"/tickets/{ticket_id}/tags",
body=await async_maybe_transform(
{
"id": id,
"admin_id": admin_id,
},
tag_create_params.TagCreateParams,
),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=Tag,
)
async def remove(
self,
id: str,
*,
ticket_id: str,
admin_id: str,
intercom_version: Literal[
"1.0",
"1.1",
"1.2",
"1.3",
"1.4",
"2.0",
"2.1",
"2.2",
"2.3",
"2.4",
"2.5",
"2.6",
"2.7",
"2.8",
"2.9",
"2.10",
"2.11",
"Unstable",
]
| NotGiven = NOT_GIVEN,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) -> Tag:
"""You can remove tag from a specific ticket.
This will return a tag object for the
tag that was removed from the ticket.
Args:
admin_id: The unique identifier for the admin which is given by Intercom.
intercom_version: Intercom API version.By default, it's equal to the version set in the app
package.
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
if not ticket_id:
raise ValueError(f"Expected a non-empty value for `ticket_id` but received {ticket_id!r}")
if not id:
raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
extra_headers = {
**strip_not_given({"Intercom-Version": str(intercom_version) if is_given(intercom_version) else NOT_GIVEN}),
**(extra_headers or {}),
}
return await self._delete(
f"/tickets/{ticket_id}/tags/{id}",
body=await async_maybe_transform({"admin_id": admin_id}, tag_remove_params.TagRemoveParams),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=Tag,
)
class TagsResourceWithRawResponse:
def __init__(self, tags: TagsResource) -> None:
self._tags = tags
self.create = to_raw_response_wrapper(
tags.create,
)
self.remove = to_raw_response_wrapper(
tags.remove,
)
class AsyncTagsResourceWithRawResponse:
def __init__(self, tags: AsyncTagsResource) -> None:
self._tags = tags
self.create = async_to_raw_response_wrapper(
tags.create,
)
self.remove = async_to_raw_response_wrapper(
tags.remove,
)
class TagsResourceWithStreamingResponse:
def __init__(self, tags: TagsResource) -> None:
self._tags = tags
self.create = to_streamed_response_wrapper(
tags.create,
)
self.remove = to_streamed_response_wrapper(
tags.remove,
)
class AsyncTagsResourceWithStreamingResponse:
def __init__(self, tags: AsyncTagsResource) -> None:
self._tags = tags
self.create = async_to_streamed_response_wrapper(
tags.create,
)
self.remove = async_to_streamed_response_wrapper(
tags.remove,
)