Skip to content

Commit 07aa7ef

Browse files
feat(api): api update
1 parent 797719a commit 07aa7ef

9 files changed

Lines changed: 51 additions & 34 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-641970ffdc1043cad290c3384d3d9c55b50cb709016a7513c03b2b84cf24fb31.yml
3-
openapi_spec_hash: e10e8093bf0dbde38523b98bec436123
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/knock%2Fknock-5176d1bb3a88b127808b197c9ae1cf366fd56599fd8c7b7241ac829e72d69a42.yml
3+
openapi_spec_hash: 92953a04021af2d0132fd9eebeb844b9
44
config_hash: 7460c5bd6d1a7041faa274f677789407

src/knockapi/resources/objects/objects.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -708,10 +708,10 @@ def set(
708708
709709
preferences: Inline set preferences for a recipient, where the key is the preference set id.
710710
711-
timezone: The timezone of the object. Must be a valid
712-
[tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
713-
Used for
714-
[recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
711+
timezone: The timezone of the object. Must be a
712+
valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
713+
Used
714+
for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
715715
716716
extra_headers: Send extra headers
717717
@@ -1544,10 +1544,10 @@ async def set(
15441544
15451545
preferences: Inline set preferences for a recipient, where the key is the preference set id.
15461546
1547-
timezone: The timezone of the object. Must be a valid
1548-
[tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
1549-
Used for
1550-
[recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
1547+
timezone: The timezone of the object. Must be a
1548+
valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
1549+
Used
1550+
for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
15511551
15521552
extra_headers: Send extra headers
15531553

src/knockapi/resources/users/users.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -140,15 +140,15 @@ def update(
140140
141141
name: Display name of the user.
142142
143-
phone_number: The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
143+
phone_number: The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
144144
user (required for SMS channels).
145145
146146
preferences: Inline set preferences for a recipient, where the key is the preference set id.
147147
148-
timezone: The timezone of the user. Must be a valid
149-
[tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
150-
Used for
151-
[recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
148+
timezone: The timezone of the user. Must be a
149+
valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
150+
Used
151+
for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
152152
153153
extra_headers: Send extra headers
154154
@@ -891,15 +891,15 @@ async def update(
891891
892892
name: Display name of the user.
893893
894-
phone_number: The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
894+
phone_number: The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
895895
user (required for SMS channels).
896896
897897
preferences: Inline set preferences for a recipient, where the key is the preference set id.
898898
899-
timezone: The timezone of the user. Must be a valid
900-
[tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
901-
Used for
902-
[recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
899+
timezone: The timezone of the user. Must be a
900+
valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
901+
Used
902+
for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
903903
904904
extra_headers: Send extra headers
905905

src/knockapi/types/audience_add_members_params.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ class MemberUser(TypedDict, total=False):
2020

2121
class Member(TypedDict, total=False):
2222
user: Required[MemberUser]
23+
"""An object containing the user's ID."""
2324

2425
tenant: Optional[str]
2526
"""The unique identifier for the tenant."""

src/knockapi/types/audience_remove_members_params.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ class MemberUser(TypedDict, total=False):
2020

2121
class Member(TypedDict, total=False):
2222
user: Required[MemberUser]
23+
"""An object containing the user's ID."""
2324

2425
tenant: Optional[str]
2526
"""The unique identifier for the tenant."""

src/knockapi/types/inline_identify_user_request_param.py

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,23 @@ class InlineIdentifyUserRequestParamTyped(TypedDict, total=False):
2323
created_at: Annotated[Union[str, datetime, None], PropertyInfo(format="iso8601")]
2424
"""The creation date of the user from your system."""
2525

26+
email: Optional[str]
27+
"""The primary email address for the user."""
28+
29+
name: Optional[str]
30+
"""Display name of the user."""
31+
2632
preferences: Optional[InlinePreferenceSetRequestParam]
2733
"""Inline set preferences for a recipient, where the key is the preference set id."""
2834

35+
timezone: Optional[str]
36+
"""The timezone of the user.
37+
38+
Must be a
39+
valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
40+
Used
41+
for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
42+
"""
43+
2944

3045
InlineIdentifyUserRequestParam: TypeAlias = Union[InlineIdentifyUserRequestParamTyped, Dict[str, object]]

src/knockapi/types/object_set_params.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ class ObjectSetParams(TypedDict, total=False):
2727
timezone: Optional[str]
2828
"""The timezone of the object.
2929
30-
Must be a valid
31-
[tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
32-
Used for
33-
[recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
30+
Must be a
31+
valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
32+
Used
33+
for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
3434
"""

src/knockapi/types/user.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,17 +34,17 @@ class User(BaseModel):
3434

3535
phone_number: Optional[str] = None
3636
"""
37-
The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
37+
The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
3838
user (required for SMS channels).
3939
"""
4040

4141
timezone: Optional[str] = None
4242
"""The timezone of the user.
4343
44-
Must be a valid
45-
[tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
46-
Used for
47-
[recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
44+
Must be a
45+
valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
46+
Used
47+
for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
4848
"""
4949

5050
if TYPE_CHECKING:

src/knockapi/types/user_update_params.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ class UserUpdateParams(TypedDict, total=False):
3737

3838
phone_number: Optional[str]
3939
"""
40-
The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
40+
The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
4141
user (required for SMS channels).
4242
"""
4343

@@ -47,8 +47,8 @@ class UserUpdateParams(TypedDict, total=False):
4747
timezone: Optional[str]
4848
"""The timezone of the user.
4949
50-
Must be a valid
51-
[tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
52-
Used for
53-
[recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
50+
Must be a
51+
valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
52+
Used
53+
for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
5454
"""

0 commit comments

Comments
 (0)