-
Notifications
You must be signed in to change notification settings - Fork 143
Expand file tree
/
Copy pathclient.py
More file actions
185 lines (141 loc) · 4.95 KB
/
client.py
File metadata and controls
185 lines (141 loc) · 4.95 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
# 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 ..types.segment_list import SegmentList
from .raw_client import AsyncRawSegmentsClient, RawSegmentsClient
from .types.segment import Segment
class SegmentsClient:
def __init__(self, *, client_wrapper: SyncClientWrapper):
self._raw_client = RawSegmentsClient(client_wrapper=client_wrapper)
@property
def with_raw_response(self) -> RawSegmentsClient:
"""
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
RawSegmentsClient
"""
return self._raw_client
def list_segments(
self, *, include_count: typing.Optional[bool] = None, request_options: typing.Optional[RequestOptions] = None
) -> SegmentList:
"""
You can fetch a list of all segments.
Parameters
----------
include_count : typing.Optional[bool]
It includes the count of contacts that belong to each segment.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
SegmentList
Successful response
Examples
--------
from intercom import Intercom
client = Intercom(
token="YOUR_TOKEN",
)
client.unstable.segments.list_segments(
include_count=True,
)
"""
_response = self._raw_client.list_segments(include_count=include_count, request_options=request_options)
return _response.data
def retrieve_segment(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Segment:
"""
You can fetch the details of a single segment.
Parameters
----------
id : str
The unique identified of a given segment.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
Segment
Successful response
Examples
--------
from intercom import Intercom
client = Intercom(
token="YOUR_TOKEN",
)
client.unstable.segments.retrieve_segment(
id="123",
)
"""
_response = self._raw_client.retrieve_segment(id, request_options=request_options)
return _response.data
class AsyncSegmentsClient:
def __init__(self, *, client_wrapper: AsyncClientWrapper):
self._raw_client = AsyncRawSegmentsClient(client_wrapper=client_wrapper)
@property
def with_raw_response(self) -> AsyncRawSegmentsClient:
"""
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
AsyncRawSegmentsClient
"""
return self._raw_client
async def list_segments(
self, *, include_count: typing.Optional[bool] = None, request_options: typing.Optional[RequestOptions] = None
) -> SegmentList:
"""
You can fetch a list of all segments.
Parameters
----------
include_count : typing.Optional[bool]
It includes the count of contacts that belong to each segment.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
SegmentList
Successful response
Examples
--------
import asyncio
from intercom import AsyncIntercom
client = AsyncIntercom(
token="YOUR_TOKEN",
)
async def main() -> None:
await client.unstable.segments.list_segments(
include_count=True,
)
asyncio.run(main())
"""
_response = await self._raw_client.list_segments(include_count=include_count, request_options=request_options)
return _response.data
async def retrieve_segment(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Segment:
"""
You can fetch the details of a single segment.
Parameters
----------
id : str
The unique identified of a given segment.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
Segment
Successful response
Examples
--------
import asyncio
from intercom import AsyncIntercom
client = AsyncIntercom(
token="YOUR_TOKEN",
)
async def main() -> None:
await client.unstable.segments.retrieve_segment(
id="123",
)
asyncio.run(main())
"""
_response = await self._raw_client.retrieve_segment(id, request_options=request_options)
return _response.data