chore: add missing docstrings

Author: stainless-app[bot]

src/knockapi/types/activity.py

@@ -12,6 +12,11 @@
 
 
 class Activity(BaseModel):
+    """An activity associated with a workflow trigger request.
+
+    Messages produced after a [batch step](/designing-workflows/batch-function) can be associated with one or more activities. Non-batched messages will always be associated with a single activity.
+    """
+
     id: Optional[str] = None
     """Unique identifier for the activity."""
 

src/knockapi/types/audience_add_members_params.py

@@ -14,11 +14,15 @@ class AudienceAddMembersParams(TypedDict, total=False):
 
 
 class MemberUser(TypedDict, total=False):
+    """An object containing the user's ID."""
+
     id: str
     """The unique identifier of the user."""
 
 
 class Member(TypedDict, total=False):
+    """An audience member."""
+
     user: Required[MemberUser]
     """An object containing the user's ID."""
 

src/knockapi/types/audience_list_members_response.py

@@ -10,6 +10,8 @@
 
 
 class AudienceListMembersResponse(BaseModel):
+    """A paginated list of audience members."""
+
     entries: List[AudienceMember]
     """A list of audience members."""
 

src/knockapi/types/audience_member.py

@@ -12,6 +12,8 @@
 
 
 class AudienceMember(BaseModel):
+    """An audience member."""
+
     api_typename: str = FieldInfo(alias="__typename")
     """The typename of the schema."""
 

src/knockapi/types/audience_remove_members_params.py

@@ -14,11 +14,15 @@ class AudienceRemoveMembersParams(TypedDict, total=False):
 
 
 class MemberUser(TypedDict, total=False):
+    """An object containing the user's ID."""
+
     id: str
     """The unique identifier of the user."""
 
 
 class Member(TypedDict, total=False):
+    """An audience member."""
+
     user: Required[MemberUser]
     """An object containing the user's ID."""
 

src/knockapi/types/bulk_operation.py

@@ -20,6 +20,8 @@ class ErrorItem(BaseModel):
 
 
 class BulkOperation(BaseModel):
+    """A bulk operation entity."""
+
     id: str
     """Unique identifier for the bulk operation."""
 

src/knockapi/types/inline_identify_user_request_param.py

@@ -14,6 +14,11 @@
 
 
 class InlineIdentifyUserRequestParamTyped(TypedDict, total=False):
+    """A set of parameters to inline-identify a user with.
+
+    Inline identifying the user will ensure that the user is available before the request is executed in Knock. It will perform an upsert for the user you're supplying, replacing any properties specified.
+    """
+
     id: Required[str]
     """The unique identifier of the user."""
 

src/knockapi/types/inline_object_request_param.py

@@ -14,6 +14,8 @@
 
 
 class InlineObjectRequestParamTyped(TypedDict, total=False):
+    """A custom [Object](/concepts/objects) entity which belongs to a collection."""
+
     id: Required[str]
     """Unique identifier for the object."""
 

src/knockapi/types/message.py

@@ -13,6 +13,8 @@
 
 
 class Source(BaseModel):
+    """The workflow or guide that triggered the message."""
+
     api_typename: str = FieldInfo(alias="__typename")
 
     categories: List[str]
@@ -45,6 +47,8 @@ class Source(BaseModel):
 
 
 class Channel(BaseModel):
+    """A configured channel, which is a way to route messages to a provider."""
+
     id: str
     """The unique identifier for the channel."""
 
@@ -68,6 +72,10 @@ class Channel(BaseModel):
 
 
 class Message(BaseModel):
+    """
+    Represents a single message that was generated by a workflow for a given channel.
+    """
+
     id: str
     """The unique identifier for the message."""
 

src/knockapi/types/message_delivery_log.py

@@ -11,6 +11,8 @@
 
 
 class Request(BaseModel):
+    """A message delivery log request."""
+
     body: Union[str, Dict[str, object], None] = None
     """The body content that was sent with the request."""
 
@@ -31,6 +33,8 @@ class Request(BaseModel):
 
 
 class Response(BaseModel):
+    """A message delivery log response."""
+
     body: Union[str, Dict[str, object], None] = None
     """The body content that was received with the response."""
 
@@ -42,6 +46,10 @@ class Response(BaseModel):
 
 
 class MessageDeliveryLog(BaseModel):
+    """
+    A message delivery log contains a `request` from Knock to a downstream provider and the `response` that was returned.
+    """
+
     id: str
     """The unique identifier for the message delivery log."""