Skip to content

feat: ring individual members + updates #75

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,41 @@ call.get_or_create(
)
```

#### Ringing Individual Members

In some cases, you may want to ring individual members instead of the whole call, or you want to ring a member into an existing call. You can do this by using the `ring` method:

```python
import uuid
from getstream import Stream

# Initialize client
client = Stream(api_key="your_api_key", api_secret="your_api_secret")

# Create a call
call = client.video.call("default", str(uuid.uuid4()))

# Create or get a call with members
call.get_or_create(
data=CallRequest(
created_by_id="myself",
members=[
MemberRequest(user_id= "myself"),
MemberRequest(user_id="my-friend")
],
)
)

# Ring an existing member
call.ring(member_ids=["my-friend"])

# Add a new member to the call and ring them
call.update_call_members(
update_members=[{"user_id": "my-other-friend"}]
)
call.ring(member_ids=["my-other-friend"])
```

### App configuration

```python
Expand Down
101 changes: 85 additions & 16 deletions getstream/chat/rest_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,24 +26,40 @@ def query_campaigns(
limit: Optional[int] = None,
next: Optional[str] = None,
prev: Optional[str] = None,
user_limit: Optional[int] = None,
sort: Optional[List[SortParamRequest]] = None,
filter: Optional[Dict[str, object]] = None,
) -> StreamResponse[QueryCampaignsResponse]:
json = build_body_dict(
limit=limit, next=next, prev=prev, sort=sort, filter=filter
limit=limit,
next=next,
prev=prev,
user_limit=user_limit,
sort=sort,
filter=filter,
)

return self.post(
"/api/v2/chat/campaigns/query", QueryCampaignsResponse, json=json
)

def get_campaign(self, id: str) -> StreamResponse[GetCampaignResponse]:
def get_campaign(
self,
id: str,
prev: Optional[str] = None,
next: Optional[str] = None,
limit: Optional[int] = None,
) -> StreamResponse[GetCampaignResponse]:
query_params = build_query_param(prev=prev, next=next, limit=limit)
path_params = {
"id": id,
}

return self.get(
"/api/v2/chat/campaigns/{id}", GetCampaignResponse, path_params=path_params
"/api/v2/chat/campaigns/{id}",
GetCampaignResponse,
query_params=query_params,
path_params=path_params,
)

def start_campaign(
Expand Down Expand Up @@ -245,6 +261,46 @@ def update_channel(
json=json,
)

def delete_draft(
self,
type: str,
id: str,
parent_id: Optional[str] = None,
user_id: Optional[str] = None,
) -> StreamResponse[Response]:
query_params = build_query_param(parent_id=parent_id, user_id=user_id)
path_params = {
"type": type,
"id": id,
}

return self.delete(
"/api/v2/chat/channels/{type}/{id}/draft",
Response,
query_params=query_params,
path_params=path_params,
)

def get_draft(
self,
type: str,
id: str,
parent_id: Optional[str] = None,
user_id: Optional[str] = None,
) -> StreamResponse[GetDraftResponse]:
query_params = build_query_param(parent_id=parent_id, user_id=user_id)
path_params = {
"type": type,
"id": id,
}

return self.get(
"/api/v2/chat/channels/{type}/{id}/draft",
GetDraftResponse,
query_params=query_params,
path_params=path_params,
)

def send_event(
self, type: str, id: str, event: EventRequest
) -> StreamResponse[EventResponse]:
Expand Down Expand Up @@ -773,6 +829,28 @@ def update_command(
json=json,
)

def query_drafts(
self,
limit: Optional[int] = None,
next: Optional[str] = None,
prev: Optional[str] = None,
user_id: Optional[str] = None,
sort: Optional[List[SortParamRequest]] = None,
filter: Optional[Dict[str, object]] = None,
user: Optional[UserRequest] = None,
) -> StreamResponse[QueryDraftsResponse]:
json = build_body_dict(
limit=limit,
next=next,
prev=prev,
user_id=user_id,
sort=sort,
filter=filter,
user=user,
)

return self.post("/api/v2/chat/drafts/query", QueryDraftsResponse, json=json)

def export_channels(
self,
channels: List[ChannelExport],
Expand All @@ -795,19 +873,6 @@ def export_channels(
"/api/v2/chat/export_channels", ExportChannelsResponse, json=json
)

def get_export_channels_status(
self, id: str
) -> StreamResponse[GetExportChannelsStatusResponse]:
path_params = {
"id": id,
}

return self.get(
"/api/v2/chat/export_channels/{id}",
GetExportChannelsStatusResponse,
path_params=path_params,
)

def query_members(
self, payload: Optional[QueryMembersPayload] = None
) -> StreamResponse[MembersResponse]:
Expand Down Expand Up @@ -1542,6 +1607,8 @@ def query_threads(
prev: Optional[str] = None,
reply_limit: Optional[int] = None,
user_id: Optional[str] = None,
sort: Optional[List[SortParamRequest]] = None,
filter: Optional[Dict[str, object]] = None,
user: Optional[UserRequest] = None,
) -> StreamResponse[QueryThreadsResponse]:
json = build_body_dict(
Expand All @@ -1552,6 +1619,8 @@ def query_threads(
prev=prev,
reply_limit=reply_limit,
user_id=user_id,
sort=sort,
filter=filter,
user=user,
)

Expand Down
2 changes: 2 additions & 0 deletions getstream/common/rest_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ def update_app(
enforce_unique_usernames: Optional[str] = None,
feeds_moderation_enabled: Optional[bool] = None,
feeds_v2_region: Optional[str] = None,
guest_user_creation_disabled: Optional[bool] = None,
image_moderation_enabled: Optional[bool] = None,
migrate_permissions_to_v2: Optional[bool] = None,
moderation_enabled: Optional[bool] = None,
Expand Down Expand Up @@ -81,6 +82,7 @@ def update_app(
enforce_unique_usernames=enforce_unique_usernames,
feeds_moderation_enabled=feeds_moderation_enabled,
feeds_v2_region=feeds_v2_region,
guest_user_creation_disabled=guest_user_creation_disabled,
image_moderation_enabled=image_moderation_enabled,
migrate_permissions_to_v2=migrate_permissions_to_v2,
moderation_enabled=moderation_enabled,
Expand Down
Loading