Skip to content

Commit 3a85980

Browse files
stainless-app[bot]stainless-app[bot]
committed
feat(api): api update
1 parent db342a3 commit 3a85980

9 files changed

Lines changed: 74 additions & 74 deletions

File tree

‎.stats.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 89
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/knock%2Fknock-91ba231183ed418e20513d0478e4a9dbc808c0506f981bff49b5154c117d10c6.yml
3-
openapi_spec_hash: 2615c3178e2d71280c54392babca0b29
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/knock%2Fknock-46f457b0a70074dc6b49569ab3c72a7aeedc111aabf2ffe84f64e5e2f386c14c.yml
3+
openapi_spec_hash: e0fe11d0ae0a6be4f9c052fa649b2a1a
44
config_hash: 2ae8965d371a03bd30c6a56819c04cf2

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ page = client.users.list_messages(
162162
"lte": "lte",
163163
},
164164
)
165-
print(page.entries)
165+
print(page.items)
166166
```
167167

168168
## Handling errors

‎api.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ Methods:
7676
- <code title="get /v1/users/{user_id}">client.users.<a href="./src/knockapi/resources/users/users.py">get</a>(user_id) -> <a href="./src/knockapi/types/user.py">User</a></code>
7777
- <code title="get /v1/users/{user_id}/channel_data/{channel_id}">client.users.<a href="./src/knockapi/resources/users/users.py">get_channel_data</a>(user_id, channel_id) -> <a href="./src/knockapi/types/recipients/channel_data.py">ChannelData</a></code>
7878
- <code title="get /v1/users/{user_id}/preferences/{id}">client.users.<a href="./src/knockapi/resources/users/users.py">get_preferences</a>(user_id, id, \*\*<a href="src/knockapi/types/user_get_preferences_params.py">params</a>) -> <a href="./src/knockapi/types/recipients/preference_set.py">PreferenceSet</a></code>
79-
- <code title="get /v1/users/{user_id}/messages">client.users.<a href="./src/knockapi/resources/users/users.py">list_messages</a>(user_id, \*\*<a href="src/knockapi/types/user_list_messages_params.py">params</a>) -> <a href="./src/knockapi/types/message.py">SyncEntriesCursor[Message]</a></code>
79+
- <code title="get /v1/users/{user_id}/messages">client.users.<a href="./src/knockapi/resources/users/users.py">list_messages</a>(user_id, \*\*<a href="src/knockapi/types/user_list_messages_params.py">params</a>) -> <a href="./src/knockapi/types/message.py">SyncItemsCursor[Message]</a></code>
8080
- <code title="get /v1/users/{user_id}/preferences">client.users.<a href="./src/knockapi/resources/users/users.py">list_preferences</a>(user_id) -> <a href="./src/knockapi/types/user_list_preferences_response.py">UserListPreferencesResponse</a></code>
8181
- <code title="get /v1/users/{user_id}/schedules">client.users.<a href="./src/knockapi/resources/users/users.py">list_schedules</a>(user_id, \*\*<a href="src/knockapi/types/user_list_schedules_params.py">params</a>) -> <a href="./src/knockapi/types/schedule.py">SyncEntriesCursor[Schedule]</a></code>
8282
- <code title="get /v1/users/{user_id}/subscriptions">client.users.<a href="./src/knockapi/resources/users/users.py">list_subscriptions</a>(user_id, \*\*<a href="src/knockapi/types/user_list_subscriptions_params.py">params</a>) -> <a href="./src/knockapi/types/recipients/subscription.py">SyncEntriesCursor[Subscription]</a></code>
@@ -151,7 +151,7 @@ Methods:
151151
- <code title="get /v1/objects/{collection}/{id}">client.objects.<a href="./src/knockapi/resources/objects/objects.py">get</a>(collection, id) -> <a href="./src/knockapi/types/object.py">Object</a></code>
152152
- <code title="get /v1/objects/{collection}/{object_id}/channel_data/{channel_id}">client.objects.<a href="./src/knockapi/resources/objects/objects.py">get_channel_data</a>(collection, object_id, channel_id) -> <a href="./src/knockapi/types/recipients/channel_data.py">ChannelData</a></code>
153153
- <code title="get /v1/objects/{collection}/{object_id}/preferences/{id}">client.objects.<a href="./src/knockapi/resources/objects/objects.py">get_preferences</a>(collection, object_id, id) -> <a href="./src/knockapi/types/recipients/preference_set.py">PreferenceSet</a></code>
154-
- <code title="get /v1/objects/{collection}/{id}/messages">client.objects.<a href="./src/knockapi/resources/objects/objects.py">list_messages</a>(collection, id, \*\*<a href="src/knockapi/types/object_list_messages_params.py">params</a>) -> <a href="./src/knockapi/types/message.py">SyncEntriesCursor[Message]</a></code>
154+
- <code title="get /v1/objects/{collection}/{id}/messages">client.objects.<a href="./src/knockapi/resources/objects/objects.py">list_messages</a>(collection, id, \*\*<a href="src/knockapi/types/object_list_messages_params.py">params</a>) -> <a href="./src/knockapi/types/message.py">SyncItemsCursor[Message]</a></code>
155155
- <code title="get /v1/objects/{collection}/{object_id}/preferences">client.objects.<a href="./src/knockapi/resources/objects/objects.py">list_preferences</a>(collection, object_id) -> <a href="./src/knockapi/types/object_list_preferences_response.py">ObjectListPreferencesResponse</a></code>
156156
- <code title="get /v1/objects/{collection}/{id}/schedules">client.objects.<a href="./src/knockapi/resources/objects/objects.py">list_schedules</a>(collection, id, \*\*<a href="src/knockapi/types/object_list_schedules_params.py">params</a>) -> <a href="./src/knockapi/types/schedule.py">SyncEntriesCursor[Schedule]</a></code>
157157
- <code title="get /v1/objects/{collection}/{object_id}/subscriptions">client.objects.<a href="./src/knockapi/resources/objects/objects.py">list_subscriptions</a>(collection, object_id, \*\*<a href="src/knockapi/types/object_list_subscriptions_params.py">params</a>) -> <a href="./src/knockapi/types/recipients/subscription.py">SyncEntriesCursor[Subscription]</a></code>
@@ -218,13 +218,13 @@ from knockapi.types import (
218218

219219
Methods:
220220

221-
- <code title="get /v1/messages">client.messages.<a href="./src/knockapi/resources/messages/messages.py">list</a>(\*\*<a href="src/knockapi/types/message_list_params.py">params</a>) -> <a href="./src/knockapi/types/message.py">SyncEntriesCursor[Message]</a></code>
221+
- <code title="get /v1/messages">client.messages.<a href="./src/knockapi/resources/messages/messages.py">list</a>(\*\*<a href="src/knockapi/types/message_list_params.py">params</a>) -> <a href="./src/knockapi/types/message.py">SyncItemsCursor[Message]</a></code>
222222
- <code title="put /v1/messages/{message_id}/archived">client.messages.<a href="./src/knockapi/resources/messages/messages.py">archive</a>(message_id) -> <a href="./src/knockapi/types/message.py">Message</a></code>
223223
- <code title="get /v1/messages/{message_id}">client.messages.<a href="./src/knockapi/resources/messages/messages.py">get</a>(message_id) -> <a href="./src/knockapi/types/message.py">Message</a></code>
224224
- <code title="get /v1/messages/{message_id}/content">client.messages.<a href="./src/knockapi/resources/messages/messages.py">get_content</a>(message_id) -> <a href="./src/knockapi/types/message_get_content_response.py">MessageGetContentResponse</a></code>
225225
- <code title="get /v1/messages/{message_id}/activities">client.messages.<a href="./src/knockapi/resources/messages/messages.py">list_activities</a>(message_id, \*\*<a href="src/knockapi/types/message_list_activities_params.py">params</a>) -> <a href="./src/knockapi/types/activity.py">SyncItemsCursor[Activity]</a></code>
226-
- <code title="get /v1/messages/{message_id}/delivery_logs">client.messages.<a href="./src/knockapi/resources/messages/messages.py">list_delivery_logs</a>(message_id, \*\*<a href="src/knockapi/types/message_list_delivery_logs_params.py">params</a>) -> <a href="./src/knockapi/types/message_delivery_log.py">SyncEntriesCursor[MessageDeliveryLog]</a></code>
227-
- <code title="get /v1/messages/{message_id}/events">client.messages.<a href="./src/knockapi/resources/messages/messages.py">list_events</a>(message_id, \*\*<a href="src/knockapi/types/message_list_events_params.py">params</a>) -> <a href="./src/knockapi/types/message_event.py">SyncEntriesCursor[MessageEvent]</a></code>
226+
- <code title="get /v1/messages/{message_id}/delivery_logs">client.messages.<a href="./src/knockapi/resources/messages/messages.py">list_delivery_logs</a>(message_id, \*\*<a href="src/knockapi/types/message_list_delivery_logs_params.py">params</a>) -> <a href="./src/knockapi/types/message_delivery_log.py">SyncItemsCursor[MessageDeliveryLog]</a></code>
227+
- <code title="get /v1/messages/{message_id}/events">client.messages.<a href="./src/knockapi/resources/messages/messages.py">list_events</a>(message_id, \*\*<a href="src/knockapi/types/message_list_events_params.py">params</a>) -> <a href="./src/knockapi/types/message_event.py">SyncItemsCursor[MessageEvent]</a></code>
228228
- <code title="put /v1/messages/{message_id}/interacted">client.messages.<a href="./src/knockapi/resources/messages/messages.py">mark_as_interacted</a>(message_id, \*\*<a href="src/knockapi/types/message_mark_as_interacted_params.py">params</a>) -> <a href="./src/knockapi/types/message.py">Message</a></code>
229229
- <code title="put /v1/messages/{message_id}/read">client.messages.<a href="./src/knockapi/resources/messages/messages.py">mark_as_read</a>(message_id) -> <a href="./src/knockapi/types/message.py">Message</a></code>
230230
- <code title="put /v1/messages/{message_id}/seen">client.messages.<a href="./src/knockapi/resources/messages/messages.py">mark_as_seen</a>(message_id) -> <a href="./src/knockapi/types/message.py">Message</a></code>

‎src/knockapi/resources/messages/messages.py‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
async_to_raw_response_wrapper,
3333
async_to_streamed_response_wrapper,
3434
)
35-
from ...pagination import SyncItemsCursor, AsyncItemsCursor, SyncEntriesCursor, AsyncEntriesCursor
35+
from ...pagination import SyncItemsCursor, AsyncItemsCursor
3636
from ..._base_client import AsyncPaginator, make_request_options
3737
from ...types.message import Message
3838
from ...types.activity import Activity
@@ -94,7 +94,7 @@ def list(
9494
extra_query: Query | None = None,
9595
extra_body: Body | None = None,
9696
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
97-
) -> SyncEntriesCursor[Message]:
97+
) -> SyncItemsCursor[Message]:
9898
"""
9999
Returns a paginated list of messages for the current environment.
100100
@@ -139,7 +139,7 @@ def list(
139139
"""
140140
return self._get_api_list(
141141
"/v1/messages",
142-
page=SyncEntriesCursor[Message],
142+
page=SyncItemsCursor[Message],
143143
options=make_request_options(
144144
extra_headers=extra_headers,
145145
extra_query=extra_query,
@@ -341,7 +341,7 @@ def list_delivery_logs(
341341
extra_query: Query | None = None,
342342
extra_body: Body | None = None,
343343
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
344-
) -> SyncEntriesCursor[MessageDeliveryLog]:
344+
) -> SyncItemsCursor[MessageDeliveryLog]:
345345
"""
346346
Returns a paginated list of delivery logs for the specified message.
347347
@@ -364,7 +364,7 @@ def list_delivery_logs(
364364
raise ValueError(f"Expected a non-empty value for `message_id` but received {message_id!r}")
365365
return self._get_api_list(
366366
f"/v1/messages/{message_id}/delivery_logs",
367-
page=SyncEntriesCursor[MessageDeliveryLog],
367+
page=SyncItemsCursor[MessageDeliveryLog],
368368
options=make_request_options(
369369
extra_headers=extra_headers,
370370
extra_query=extra_query,
@@ -395,7 +395,7 @@ def list_events(
395395
extra_query: Query | None = None,
396396
extra_body: Body | None = None,
397397
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
398-
) -> SyncEntriesCursor[MessageEvent]:
398+
) -> SyncItemsCursor[MessageEvent]:
399399
"""
400400
Returns a paginated list of events for the specified message.
401401
@@ -418,7 +418,7 @@ def list_events(
418418
raise ValueError(f"Expected a non-empty value for `message_id` but received {message_id!r}")
419419
return self._get_api_list(
420420
f"/v1/messages/{message_id}/events",
421-
page=SyncEntriesCursor[MessageEvent],
421+
page=SyncItemsCursor[MessageEvent],
422422
options=make_request_options(
423423
extra_headers=extra_headers,
424424
extra_query=extra_query,
@@ -710,7 +710,7 @@ def list(
710710
extra_query: Query | None = None,
711711
extra_body: Body | None = None,
712712
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
713-
) -> AsyncPaginator[Message, AsyncEntriesCursor[Message]]:
713+
) -> AsyncPaginator[Message, AsyncItemsCursor[Message]]:
714714
"""
715715
Returns a paginated list of messages for the current environment.
716716
@@ -755,7 +755,7 @@ def list(
755755
"""
756756
return self._get_api_list(
757757
"/v1/messages",
758-
page=AsyncEntriesCursor[Message],
758+
page=AsyncItemsCursor[Message],
759759
options=make_request_options(
760760
extra_headers=extra_headers,
761761
extra_query=extra_query,
@@ -957,7 +957,7 @@ def list_delivery_logs(
957957
extra_query: Query | None = None,
958958
extra_body: Body | None = None,
959959
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
960-
) -> AsyncPaginator[MessageDeliveryLog, AsyncEntriesCursor[MessageDeliveryLog]]:
960+
) -> AsyncPaginator[MessageDeliveryLog, AsyncItemsCursor[MessageDeliveryLog]]:
961961
"""
962962
Returns a paginated list of delivery logs for the specified message.
963963
@@ -980,7 +980,7 @@ def list_delivery_logs(
980980
raise ValueError(f"Expected a non-empty value for `message_id` but received {message_id!r}")
981981
return self._get_api_list(
982982
f"/v1/messages/{message_id}/delivery_logs",
983-
page=AsyncEntriesCursor[MessageDeliveryLog],
983+
page=AsyncItemsCursor[MessageDeliveryLog],
984984
options=make_request_options(
985985
extra_headers=extra_headers,
986986
extra_query=extra_query,
@@ -1011,7 +1011,7 @@ def list_events(
10111011
extra_query: Query | None = None,
10121012
extra_body: Body | None = None,
10131013
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
1014-
) -> AsyncPaginator[MessageEvent, AsyncEntriesCursor[MessageEvent]]:
1014+
) -> AsyncPaginator[MessageEvent, AsyncItemsCursor[MessageEvent]]:
10151015
"""
10161016
Returns a paginated list of events for the specified message.
10171017
@@ -1034,7 +1034,7 @@ def list_events(
10341034
raise ValueError(f"Expected a non-empty value for `message_id` but received {message_id!r}")
10351035
return self._get_api_list(
10361036
f"/v1/messages/{message_id}/events",
1037-
page=AsyncEntriesCursor[MessageEvent],
1037+
page=AsyncItemsCursor[MessageEvent],
10381038
options=make_request_options(
10391039
extra_headers=extra_headers,
10401040
extra_query=extra_query,

‎src/knockapi/resources/objects/objects.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
async_to_raw_response_wrapper,
3737
async_to_streamed_response_wrapper,
3838
)
39-
from ...pagination import SyncEntriesCursor, AsyncEntriesCursor
39+
from ...pagination import SyncItemsCursor, AsyncItemsCursor, SyncEntriesCursor, AsyncEntriesCursor
4040
from ..._base_client import AsyncPaginator, make_request_options
4141
from ...types.object import Object
4242
from ...types.message import Message
@@ -422,7 +422,7 @@ def list_messages(
422422
extra_query: Query | None = None,
423423
extra_body: Body | None = None,
424424
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
425-
) -> SyncEntriesCursor[Message]:
425+
) -> SyncItemsCursor[Message]:
426426
"""
427427
Returns a paginated list of messages for a specific object in the given
428428
collection. Allows filtering by message status and provides various sorting
@@ -473,7 +473,7 @@ def list_messages(
473473
raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
474474
return self._get_api_list(
475475
f"/v1/objects/{collection}/{id}/messages",
476-
page=SyncEntriesCursor[Message],
476+
page=SyncItemsCursor[Message],
477477
options=make_request_options(
478478
extra_headers=extra_headers,
479479
extra_query=extra_query,
@@ -1260,7 +1260,7 @@ def list_messages(
12601260
extra_query: Query | None = None,
12611261
extra_body: Body | None = None,
12621262
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
1263-
) -> AsyncPaginator[Message, AsyncEntriesCursor[Message]]:
1263+
) -> AsyncPaginator[Message, AsyncItemsCursor[Message]]:
12641264
"""
12651265
Returns a paginated list of messages for a specific object in the given
12661266
collection. Allows filtering by message status and provides various sorting
@@ -1311,7 +1311,7 @@ def list_messages(
13111311
raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
13121312
return self._get_api_list(
13131313
f"/v1/objects/{collection}/{id}/messages",
1314-
page=AsyncEntriesCursor[Message],
1314+
page=AsyncItemsCursor[Message],
13151315
options=make_request_options(
13161316
extra_headers=extra_headers,
13171317
extra_query=extra_query,

‎src/knockapi/resources/users/users.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@
5353
async_to_raw_response_wrapper,
5454
async_to_streamed_response_wrapper,
5555
)
56-
from ...pagination import SyncEntriesCursor, AsyncEntriesCursor
56+
from ...pagination import SyncItemsCursor, AsyncItemsCursor, SyncEntriesCursor, AsyncEntriesCursor
5757
from ...types.user import User
5858
from ..._base_client import AsyncPaginator, make_request_options
5959
from ...types.message import Message
@@ -413,7 +413,7 @@ def list_messages(
413413
extra_query: Query | None = None,
414414
extra_body: Body | None = None,
415415
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
416-
) -> SyncEntriesCursor[Message]:
416+
) -> SyncItemsCursor[Message]:
417417
"""Returns a paginated list of messages for a specific user.
418418
419419
Allows filtering by
@@ -463,7 +463,7 @@ def list_messages(
463463
raise ValueError(f"Expected a non-empty value for `user_id` but received {user_id!r}")
464464
return self._get_api_list(
465465
f"/v1/users/{user_id}/messages",
466-
page=SyncEntriesCursor[Message],
466+
page=SyncItemsCursor[Message],
467467
options=make_request_options(
468468
extra_headers=extra_headers,
469469
extra_query=extra_query,
@@ -1168,7 +1168,7 @@ def list_messages(
11681168
extra_query: Query | None = None,
11691169
extra_body: Body | None = None,
11701170
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
1171-
) -> AsyncPaginator[Message, AsyncEntriesCursor[Message]]:
1171+
) -> AsyncPaginator[Message, AsyncItemsCursor[Message]]:
11721172
"""Returns a paginated list of messages for a specific user.
11731173
11741174
Allows filtering by
@@ -1218,7 +1218,7 @@ def list_messages(
12181218
raise ValueError(f"Expected a non-empty value for `user_id` but received {user_id!r}")
12191219
return self._get_api_list(
12201220
f"/v1/users/{user_id}/messages",
1221-
page=AsyncEntriesCursor[Message],
1221+
page=AsyncItemsCursor[Message],
12221222
options=make_request_options(
12231223
extra_headers=extra_headers,
12241224
extra_query=extra_query,

0 commit comments

Comments
 (0)