-
Notifications
You must be signed in to change notification settings - Fork 15
Expand file tree
/
Copy pathitems.py
More file actions
304 lines (253 loc) · 11.7 KB
/
items.py
File metadata and controls
304 lines (253 loc) · 11.7 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
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
from __future__ import annotations
from typing import List, Optional
from typing_extensions import Literal
import httpx
from ...._types import Body, Omit, Query, Headers, NoneType, NotGiven, omit, not_given
from ...._utils import path_template, maybe_transform, 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.tenants.preferences import item_update_params
from ....types.shared.channel_classification import ChannelClassification
__all__ = ["ItemsResource", "AsyncItemsResource"]
class ItemsResource(SyncAPIResource):
@cached_property
def with_raw_response(self) -> ItemsResourceWithRawResponse:
"""
This property can be used as a prefix for any HTTP method call to return
the raw response object instead of the parsed content.
For more information, see https://www.github.com/trycourier/courier-python#accessing-raw-response-data-eg-headers
"""
return ItemsResourceWithRawResponse(self)
@cached_property
def with_streaming_response(self) -> ItemsResourceWithStreamingResponse:
"""
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
For more information, see https://www.github.com/trycourier/courier-python#with_streaming_response
"""
return ItemsResourceWithStreamingResponse(self)
def update(
self,
topic_id: str,
*,
tenant_id: str,
status: Literal["OPTED_OUT", "OPTED_IN", "REQUIRED"],
custom_routing: Optional[List[ChannelClassification]] | Omit = omit,
has_custom_routing: Optional[bool] | Omit = omit,
# 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,
) -> None:
"""
Create or Replace Default Preferences For Topic
Args:
custom_routing: The default channels to send to this tenant when has_custom_routing is enabled
has_custom_routing: Override channel routing with custom preferences. This will override any
template preferences that are set, but a user can still customize their
preferences
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 tenant_id:
raise ValueError(f"Expected a non-empty value for `tenant_id` but received {tenant_id!r}")
if not topic_id:
raise ValueError(f"Expected a non-empty value for `topic_id` but received {topic_id!r}")
extra_headers = {"Accept": "*/*", **(extra_headers or {})}
return self._put(
path_template(
"/tenants/{tenant_id}/default_preferences/items/{topic_id}", tenant_id=tenant_id, topic_id=topic_id
),
body=maybe_transform(
{
"status": status,
"custom_routing": custom_routing,
"has_custom_routing": has_custom_routing,
},
item_update_params.ItemUpdateParams,
),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=NoneType,
)
def delete(
self,
topic_id: str,
*,
tenant_id: str,
# 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,
) -> None:
"""
Remove Default Preferences For Topic
Args:
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 tenant_id:
raise ValueError(f"Expected a non-empty value for `tenant_id` but received {tenant_id!r}")
if not topic_id:
raise ValueError(f"Expected a non-empty value for `topic_id` but received {topic_id!r}")
extra_headers = {"Accept": "*/*", **(extra_headers or {})}
return self._delete(
path_template(
"/tenants/{tenant_id}/default_preferences/items/{topic_id}", tenant_id=tenant_id, topic_id=topic_id
),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=NoneType,
)
class AsyncItemsResource(AsyncAPIResource):
@cached_property
def with_raw_response(self) -> AsyncItemsResourceWithRawResponse:
"""
This property can be used as a prefix for any HTTP method call to return
the raw response object instead of the parsed content.
For more information, see https://www.github.com/trycourier/courier-python#accessing-raw-response-data-eg-headers
"""
return AsyncItemsResourceWithRawResponse(self)
@cached_property
def with_streaming_response(self) -> AsyncItemsResourceWithStreamingResponse:
"""
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
For more information, see https://www.github.com/trycourier/courier-python#with_streaming_response
"""
return AsyncItemsResourceWithStreamingResponse(self)
async def update(
self,
topic_id: str,
*,
tenant_id: str,
status: Literal["OPTED_OUT", "OPTED_IN", "REQUIRED"],
custom_routing: Optional[List[ChannelClassification]] | Omit = omit,
has_custom_routing: Optional[bool] | Omit = omit,
# 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,
) -> None:
"""
Create or Replace Default Preferences For Topic
Args:
custom_routing: The default channels to send to this tenant when has_custom_routing is enabled
has_custom_routing: Override channel routing with custom preferences. This will override any
template preferences that are set, but a user can still customize their
preferences
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 tenant_id:
raise ValueError(f"Expected a non-empty value for `tenant_id` but received {tenant_id!r}")
if not topic_id:
raise ValueError(f"Expected a non-empty value for `topic_id` but received {topic_id!r}")
extra_headers = {"Accept": "*/*", **(extra_headers or {})}
return await self._put(
path_template(
"/tenants/{tenant_id}/default_preferences/items/{topic_id}", tenant_id=tenant_id, topic_id=topic_id
),
body=await async_maybe_transform(
{
"status": status,
"custom_routing": custom_routing,
"has_custom_routing": has_custom_routing,
},
item_update_params.ItemUpdateParams,
),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=NoneType,
)
async def delete(
self,
topic_id: str,
*,
tenant_id: str,
# 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,
) -> None:
"""
Remove Default Preferences For Topic
Args:
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 tenant_id:
raise ValueError(f"Expected a non-empty value for `tenant_id` but received {tenant_id!r}")
if not topic_id:
raise ValueError(f"Expected a non-empty value for `topic_id` but received {topic_id!r}")
extra_headers = {"Accept": "*/*", **(extra_headers or {})}
return await self._delete(
path_template(
"/tenants/{tenant_id}/default_preferences/items/{topic_id}", tenant_id=tenant_id, topic_id=topic_id
),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=NoneType,
)
class ItemsResourceWithRawResponse:
def __init__(self, items: ItemsResource) -> None:
self._items = items
self.update = to_raw_response_wrapper(
items.update,
)
self.delete = to_raw_response_wrapper(
items.delete,
)
class AsyncItemsResourceWithRawResponse:
def __init__(self, items: AsyncItemsResource) -> None:
self._items = items
self.update = async_to_raw_response_wrapper(
items.update,
)
self.delete = async_to_raw_response_wrapper(
items.delete,
)
class ItemsResourceWithStreamingResponse:
def __init__(self, items: ItemsResource) -> None:
self._items = items
self.update = to_streamed_response_wrapper(
items.update,
)
self.delete = to_streamed_response_wrapper(
items.delete,
)
class AsyncItemsResourceWithStreamingResponse:
def __init__(self, items: AsyncItemsResource) -> None:
self._items = items
self.update = async_to_streamed_response_wrapper(
items.update,
)
self.delete = async_to_streamed_response_wrapper(
items.delete,
)