GroupV2 Routes

GroupV2RouteInterface

Bases: ClientMixin

Source code in src/bungio/api/bungie/group_v2.py

@custom_define()
class GroupV2RouteInterface(ClientMixin):
    async def get_available_avatars(self, auth: Optional[AuthData] = None) -> dict[int, str]:
        """
        Returns a list of all available group avatars for the signed-in user.

        Args:
            auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

        Returns:
            The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
        """

        response = await self._client.http.get_available_avatars(auth=auth)
        return {key: value async for key, value in AllowAsyncIteration(response["Response"].items())}

    async def get_available_themes(self, auth: Optional[AuthData] = None) -> list[GroupTheme]:
        """
        Returns a list of all available group themes.

        Args:
            auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

        Returns:
            The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
        """

        response = await self._client.http.get_available_themes(auth=auth)
        return [
            await GroupTheme.from_dict(data=value, client=self._client, auth=auth) for value in response["Response"]
        ]

    async def get_user_clan_invite_setting(self, m_type: Union[BungieMembershipType, int], auth: AuthData) -> bool:
        """
        Gets the state of the user's clan invite preferences for a particular membership type - true if they wish to be invited to clans, false otherwise.

        Warning: Requires Authentication.
            Required oauth2 scopes: ReadUserData

        Args:
            m_type: The Destiny membership type of the account we wish to access settings.
            auth: Authentication information.

        Returns:
            The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
        """

        response = await self._client.http.get_user_clan_invite_setting(
            m_type=getattr(m_type, "value", m_type), auth=auth
        )
        return response["Response"]

    async def get_recommended_groups(
        self, create_date_range: Union[GroupDateRange, int], group_type: Union[GroupType, int], auth: AuthData
    ) -> list[GroupV2Card]:
        """
        Gets groups recommended for you based on the groups to whom those you follow belong.

        Warning: Requires Authentication.
            Required oauth2 scopes: ReadGroups

        Args:
            create_date_range: Requested range in which to pull recommended groups
            group_type: Type of groups requested
            auth: Authentication information.

        Returns:
            The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
        """

        response = await self._client.http.get_recommended_groups(
            create_date_range=getattr(create_date_range, "value", create_date_range),
            group_type=getattr(group_type, "value", group_type),
            auth=auth,
        )
        return [
            await GroupV2Card.from_dict(
                data=value, client=self._client, create_date_range=create_date_range, group_type=group_type, auth=auth
            )
            for value in response["Response"]
        ]

    async def group_search(self, data: GroupQuery, auth: Optional[AuthData] = None) -> GroupSearchResponse:
        """
        Search for Groups.

        Args:
            data: The required data for this request.
            auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

        Returns:
            The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
        """

        response = await self._client.http.group_search(auth=auth, **data.to_dict(_return_to_bungie_case=False))
        return await GroupSearchResponse.from_dict(data=response, client=self._client, auth=auth)

    async def get_group(self, group_id: int, auth: Optional[AuthData] = None) -> GroupResponse:
        """
        Get information about a specific group of the given ID.

        Args:
            group_id: Requested group's id.
            auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

        Returns:
            The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
        """

        response = await self._client.http.get_group(group_id=group_id, auth=auth)
        return await GroupResponse.from_dict(data=response, client=self._client, group_id=group_id, auth=auth)

    async def get_group_by_name(
        self, group_name: str, group_type: Union[GroupType, int], auth: Optional[AuthData] = None
    ) -> GroupResponse:
        """
        Get information about a specific group with the given name and type.

        Args:
            group_name: Exact name of the group to find.
            group_type: Type of group to find.
            auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

        Returns:
            The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
        """

        response = await self._client.http.get_group_by_name(
            group_name=group_name, group_type=getattr(group_type, "value", group_type), auth=auth
        )
        return await GroupResponse.from_dict(
            data=response, client=self._client, group_name=group_name, group_type=group_type, auth=auth
        )

    async def get_group_by_name_v2(
        self, data: GroupNameSearchRequest, auth: Optional[AuthData] = None
    ) -> GroupResponse:
        """
        Get information about a specific group with the given name and type. The POST version.

        Args:
            data: The required data for this request.
            auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

        Returns:
            The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
        """

        response = await self._client.http.get_group_by_name_v2(auth=auth, **data.to_dict(_return_to_bungie_case=False))
        return await GroupResponse.from_dict(data=response, client=self._client, auth=auth)

    async def get_group_optional_conversations(
        self, group_id: int, auth: Optional[AuthData] = None
    ) -> list[GroupOptionalConversation]:
        """
        Gets a list of available optional conversation channels and their settings.

        Args:
            group_id: Requested group's id.
            auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

        Returns:
            The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
        """

        response = await self._client.http.get_group_optional_conversations(group_id=group_id, auth=auth)
        return [
            await GroupOptionalConversation.from_dict(data=value, client=self._client, group_id=group_id, auth=auth)
            for value in response["Response"]
        ]

    async def edit_group(self, data: GroupEditAction, group_id: int, auth: AuthData) -> int:
        """
        Edit an existing group. You must have suitable permissions in the group to perform this operation. This latest revision will only edit the fields you pass in - pass null for properties you want to leave unaltered.

        Warning: Requires Authentication.
            Required oauth2 scopes: AdminGroups

        Args:
            data: The required data for this request.
            group_id: Group ID of the group to edit.
            auth: Authentication information.

        Returns:
            The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
        """

        response = await self._client.http.edit_group(
            group_id=group_id, auth=auth, **data.to_dict(_return_to_bungie_case=False)
        )
        return response["Response"]

    async def edit_clan_banner(self, data: ClanBanner, group_id: int, auth: AuthData) -> int:
        """
        Edit an existing group's clan banner. You must have suitable permissions in the group to perform this operation. All fields are required.

        Warning: Requires Authentication.
            Required oauth2 scopes: AdminGroups

        Args:
            data: The required data for this request.
            group_id: Group ID of the group to edit.
            auth: Authentication information.

        Returns:
            The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
        """

        response = await self._client.http.edit_clan_banner(
            group_id=group_id, auth=auth, **data.to_dict(_return_to_bungie_case=False)
        )
        return response["Response"]

    async def edit_founder_options(self, data: GroupOptionsEditAction, group_id: int, auth: AuthData) -> int:
        """
        Edit group options only available to a founder. You must have suitable permissions in the group to perform this operation.

        Warning: Requires Authentication.
            Required oauth2 scopes: AdminGroups

        Args:
            data: The required data for this request.
            group_id: Group ID of the group to edit.
            auth: Authentication information.

        Returns:
            The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
        """

        response = await self._client.http.edit_founder_options(
            group_id=group_id, auth=auth, **data.to_dict(_return_to_bungie_case=False)
        )
        return response["Response"]

    async def add_optional_conversation(
        self, data: GroupOptionalConversationAddRequest, group_id: int, auth: AuthData
    ) -> int:
        """
        Add a new optional conversation/chat channel. Requires admin permissions to the group.

        Warning: Requires Authentication.
            Required oauth2 scopes: AdminGroups

        Args:
            data: The required data for this request.
            group_id: Group ID of the group to edit.
            auth: Authentication information.

        Returns:
            The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
        """

        response = await self._client.http.add_optional_conversation(
            group_id=group_id, auth=auth, **data.to_dict(_return_to_bungie_case=False)
        )
        return response["Response"]

    async def edit_optional_conversation(
        self, data: GroupOptionalConversationEditRequest, conversation_id: int, group_id: int, auth: AuthData
    ) -> int:
        """
        Edit the settings of an optional conversation/chat channel. Requires admin permissions to the group.

        Warning: Requires Authentication.
            Required oauth2 scopes: AdminGroups

        Args:
            data: The required data for this request.
            conversation_id: Conversation Id of the channel being edited.
            group_id: Group ID of the group to edit.
            auth: Authentication information.

        Returns:
            The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
        """

        response = await self._client.http.edit_optional_conversation(
            conversation_id=conversation_id, group_id=group_id, auth=auth, **data.to_dict(_return_to_bungie_case=False)
        )
        return response["Response"]

    async def get_members_of_group(
        self,
        currentpage: int,
        group_id: int,
        member_type: Optional[Union[RuntimeGroupMemberType, int]] = None,
        name_search: Optional[str] = None,
        auth: Optional[AuthData] = None,
    ) -> SearchResultOfGroupMember:
        """
        Get the list of members in a given group.

        Args:
            currentpage: Page number (starting with 1). Each page has a fixed size of 50 items per page.
            group_id: The ID of the group.
            member_type: Filter out other member types. Use None for all members.
            name_search: The name fragment upon which a search should be executed for members with matching display or unique names.
            auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

        Returns:
            The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
        """

        response = await self._client.http.get_members_of_group(
            currentpage=currentpage,
            group_id=group_id,
            member_type=getattr(member_type, "value", member_type) if member_type is not None else None,
            name_search=name_search if name_search is not None else None,
            auth=auth,
        )
        return await SearchResultOfGroupMember.from_dict(
            data=response,
            client=self._client,
            currentpage=currentpage,
            group_id=group_id,
            member_type=member_type,
            name_search=name_search,
            auth=auth,
        )

    async def get_admins_and_founder_of_group(
        self, currentpage: int, group_id: int, auth: Optional[AuthData] = None
    ) -> SearchResultOfGroupMember:
        """
        Get the list of members in a given group who are of admin level or higher.

        Args:
            currentpage: Page number (starting with 1). Each page has a fixed size of 50 items per page.
            group_id: The ID of the group.
            auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

        Returns:
            The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
        """

        response = await self._client.http.get_admins_and_founder_of_group(
            currentpage=currentpage, group_id=group_id, auth=auth
        )
        return await SearchResultOfGroupMember.from_dict(
            data=response, client=self._client, currentpage=currentpage, group_id=group_id, auth=auth
        )

    async def edit_group_membership(
        self,
        group_id: int,
        membership_id: int,
        membership_type: Union[BungieMembershipType, int],
        member_type: Union[RuntimeGroupMemberType, int],
        auth: AuthData,
    ) -> int:
        """
        Edit the membership type of a given member. You must have suitable permissions in the group to perform this operation.

        Warning: Requires Authentication.
            Required oauth2 scopes: AdminGroups

        Args:
            group_id: ID of the group to which the member belongs.
            membership_id: Membership ID to modify.
            membership_type: Membership type of the provide membership ID.
            member_type: New membertype for the specified member.
            auth: Authentication information.

        Returns:
            The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
        """

        response = await self._client.http.edit_group_membership(
            group_id=group_id,
            membership_id=membership_id,
            membership_type=getattr(membership_type, "value", membership_type),
            member_type=getattr(member_type, "value", member_type),
            auth=auth,
        )
        return response["Response"]

    async def kick_member(
        self, group_id: int, membership_id: int, membership_type: Union[BungieMembershipType, int], auth: AuthData
    ) -> GroupMemberLeaveResult:
        """
        Kick a member from the given group, forcing them to reapply if they wish to re-join the group. You must have suitable permissions in the group to perform this operation.

        Warning: Requires Authentication.
            Required oauth2 scopes: AdminGroups

        Args:
            group_id: Group ID to kick the user from.
            membership_id: Membership ID to kick.
            membership_type: Membership type of the provided membership ID.
            auth: Authentication information.

        Returns:
            The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
        """

        response = await self._client.http.kick_member(
            group_id=group_id,
            membership_id=membership_id,
            membership_type=getattr(membership_type, "value", membership_type),
            auth=auth,
        )
        return await GroupMemberLeaveResult.from_dict(
            data=response,
            client=self._client,
            group_id=group_id,
            membership_id=membership_id,
            membership_type=membership_type,
            auth=auth,
        )

    async def ban_member(
        self,
        data: GroupBanRequest,
        group_id: int,
        membership_id: int,
        membership_type: Union[BungieMembershipType, int],
        auth: AuthData,
    ) -> int:
        """
        Bans the requested member from the requested group for the specified period of time.

        Warning: Requires Authentication.
            Required oauth2 scopes: AdminGroups

        Args:
            data: The required data for this request.
            group_id: Group ID that has the member to ban.
            membership_id: Membership ID of the member to ban from the group.
            membership_type: Membership type of the provided membership ID.
            auth: Authentication information.

        Returns:
            The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
        """

        response = await self._client.http.ban_member(
            group_id=group_id,
            membership_id=membership_id,
            membership_type=getattr(membership_type, "value", membership_type),
            auth=auth,
            **data.to_dict(_return_to_bungie_case=False),
        )
        return response["Response"]

    async def unban_member(
        self, group_id: int, membership_id: int, membership_type: Union[BungieMembershipType, int], auth: AuthData
    ) -> int:
        """
        Unbans the requested member, allowing them to re-apply for membership.

        Warning: Requires Authentication.
            Required oauth2 scopes: AdminGroups

        Args:
            group_id:
            membership_id: Membership ID of the member to unban from the group
            membership_type: Membership type of the provided membership ID.
            auth: Authentication information.

        Returns:
            The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
        """

        response = await self._client.http.unban_member(
            group_id=group_id,
            membership_id=membership_id,
            membership_type=getattr(membership_type, "value", membership_type),
            auth=auth,
        )
        return response["Response"]

    async def get_banned_members_of_group(
        self, currentpage: int, group_id: int, auth: AuthData
    ) -> SearchResultOfGroupBan:
        """
        Get the list of banned members in a given group. Only accessible to group Admins and above. Not applicable to all groups. Check group features.

        Warning: Requires Authentication.
            Required oauth2 scopes: AdminGroups

        Args:
            currentpage: Page number (starting with 1). Each page has a fixed size of 50 entries.
            group_id: Group ID whose banned members you are fetching
            auth: Authentication information.

        Returns:
            The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
        """

        response = await self._client.http.get_banned_members_of_group(
            currentpage=currentpage, group_id=group_id, auth=auth
        )
        return await SearchResultOfGroupBan.from_dict(
            data=response, client=self._client, currentpage=currentpage, group_id=group_id, auth=auth
        )

    async def get_group_edit_history(
        self, currentpage: int, group_id: int, auth: AuthData
    ) -> SearchResultOfGroupEditHistory:
        """
        Get the list of edits made to a given group. Only accessible to group Admins and above.

        Warning: Requires Authentication.
            Required oauth2 scopes: AdminGroups

        Args:
            currentpage: Page number (starting with 1). Each page has a fixed size of 50 entries.
            group_id: Group ID whose edit history you are fetching
            auth: Authentication information.

        Returns:
            The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
        """

        response = await self._client.http.get_group_edit_history(currentpage=currentpage, group_id=group_id, auth=auth)
        return await SearchResultOfGroupEditHistory.from_dict(
            data=response, client=self._client, currentpage=currentpage, group_id=group_id, auth=auth
        )

    async def abdicate_foundership(
        self,
        founder_id_new: int,
        group_id: int,
        membership_type: Union[BungieMembershipType, int],
        auth: Optional[AuthData] = None,
    ) -> bool:
        """
        An administrative method to allow the founder of a group or clan to give up their position to another admin permanently.

        Args:
            founder_id_new: The new founder for this group. Must already be a group admin.
            group_id: The target group id.
            membership_type: Membership type of the provided founderIdNew.
            auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

        Returns:
            The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
        """

        response = await self._client.http.abdicate_foundership(
            founder_id_new=founder_id_new,
            group_id=group_id,
            membership_type=getattr(membership_type, "value", membership_type),
            auth=auth,
        )
        return response["Response"]

    async def get_pending_memberships(
        self, currentpage: int, group_id: int, auth: AuthData
    ) -> SearchResultOfGroupMemberApplication:
        """
        Get the list of users who are awaiting a decision on their application to join a given group. Modified to include application info.

        Warning: Requires Authentication.
            Required oauth2 scopes: AdminGroups

        Args:
            currentpage: Page number (starting with 1). Each page has a fixed size of 50 items per page.
            group_id: ID of the group.
            auth: Authentication information.

        Returns:
            The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
        """

        response = await self._client.http.get_pending_memberships(
            currentpage=currentpage, group_id=group_id, auth=auth
        )
        return await SearchResultOfGroupMemberApplication.from_dict(
            data=response, client=self._client, currentpage=currentpage, group_id=group_id, auth=auth
        )

    async def get_invited_individuals(
        self, currentpage: int, group_id: int, auth: AuthData
    ) -> SearchResultOfGroupMemberApplication:
        """
        Get the list of users who have been invited into the group.

        Warning: Requires Authentication.
            Required oauth2 scopes: AdminGroups

        Args:
            currentpage: Page number (starting with 1). Each page has a fixed size of 50 items per page.
            group_id: ID of the group.
            auth: Authentication information.

        Returns:
            The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
        """

        response = await self._client.http.get_invited_individuals(
            currentpage=currentpage, group_id=group_id, auth=auth
        )
        return await SearchResultOfGroupMemberApplication.from_dict(
            data=response, client=self._client, currentpage=currentpage, group_id=group_id, auth=auth
        )

    async def approve_all_pending(
        self, data: GroupApplicationRequest, group_id: int, auth: AuthData
    ) -> list[EntityActionResult]:
        """
        Approve all of the pending users for the given group.

        Warning: Requires Authentication.
            Required oauth2 scopes: AdminGroups

        Args:
            data: The required data for this request.
            group_id: ID of the group.
            auth: Authentication information.

        Returns:
            The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
        """

        response = await self._client.http.approve_all_pending(
            group_id=group_id, auth=auth, **data.to_dict(_return_to_bungie_case=False)
        )
        return [
            await EntityActionResult.from_dict(data=value, client=self._client, group_id=group_id, auth=auth)
            for value in response["Response"]
        ]

    async def deny_all_pending(
        self, data: GroupApplicationRequest, group_id: int, auth: AuthData
    ) -> list[EntityActionResult]:
        """
        Deny all of the pending users for the given group.

        Warning: Requires Authentication.
            Required oauth2 scopes: AdminGroups

        Args:
            data: The required data for this request.
            group_id: ID of the group.
            auth: Authentication information.

        Returns:
            The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
        """

        response = await self._client.http.deny_all_pending(
            group_id=group_id, auth=auth, **data.to_dict(_return_to_bungie_case=False)
        )
        return [
            await EntityActionResult.from_dict(data=value, client=self._client, group_id=group_id, auth=auth)
            for value in response["Response"]
        ]

    async def approve_pending_for_list(
        self, data: GroupApplicationListRequest, group_id: int, auth: AuthData
    ) -> list[EntityActionResult]:
        """
        Approve all of the pending users for the given group.

        Warning: Requires Authentication.
            Required oauth2 scopes: AdminGroups

        Args:
            data: The required data for this request.
            group_id: ID of the group.
            auth: Authentication information.

        Returns:
            The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
        """

        response = await self._client.http.approve_pending_for_list(
            group_id=group_id, auth=auth, **data.to_dict(_return_to_bungie_case=False)
        )
        return [
            await EntityActionResult.from_dict(data=value, client=self._client, group_id=group_id, auth=auth)
            for value in response["Response"]
        ]

    async def approve_pending(
        self,
        data: GroupApplicationRequest,
        group_id: int,
        membership_id: int,
        membership_type: Union[BungieMembershipType, int],
        auth: AuthData,
    ) -> bool:
        """
        Approve the given membershipId to join the group/clan as long as they have applied.

        Warning: Requires Authentication.
            Required oauth2 scopes: AdminGroups

        Args:
            data: The required data for this request.
            group_id: ID of the group.
            membership_id: The membership id being approved.
            membership_type: Membership type of the supplied membership ID.
            auth: Authentication information.

        Returns:
            The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
        """

        response = await self._client.http.approve_pending(
            group_id=group_id,
            membership_id=membership_id,
            membership_type=getattr(membership_type, "value", membership_type),
            auth=auth,
            **data.to_dict(_return_to_bungie_case=False),
        )
        return response["Response"]

    async def deny_pending_for_list(
        self, data: GroupApplicationListRequest, group_id: int, auth: AuthData
    ) -> list[EntityActionResult]:
        """
        Deny all of the pending users for the given group that match the passed-in .

        Warning: Requires Authentication.
            Required oauth2 scopes: AdminGroups

        Args:
            data: The required data for this request.
            group_id: ID of the group.
            auth: Authentication information.

        Returns:
            The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
        """

        response = await self._client.http.deny_pending_for_list(
            group_id=group_id, auth=auth, **data.to_dict(_return_to_bungie_case=False)
        )
        return [
            await EntityActionResult.from_dict(data=value, client=self._client, group_id=group_id, auth=auth)
            for value in response["Response"]
        ]

    async def get_groups_for_member(
        self,
        filter: Union[GroupsForMemberFilter, int],
        group_type: Union[GroupType, int],
        membership_id: int,
        membership_type: Union[BungieMembershipType, int],
        auth: Optional[AuthData] = None,
    ) -> GetGroupsForMemberResponse:
        """
        Get information about the groups that a given member has joined.

        Args:
            filter: Filter apply to list of joined groups.
            group_type: Type of group the supplied member founded.
            membership_id: Membership ID to for which to find founded groups.
            membership_type: Membership type of the supplied membership ID.
            auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

        Returns:
            The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
        """

        response = await self._client.http.get_groups_for_member(
            filter=getattr(filter, "value", filter),
            group_type=getattr(group_type, "value", group_type),
            membership_id=membership_id,
            membership_type=getattr(membership_type, "value", membership_type),
            auth=auth,
        )
        return await GetGroupsForMemberResponse.from_dict(
            data=response,
            client=self._client,
            filter=filter,
            group_type=group_type,
            membership_id=membership_id,
            membership_type=membership_type,
            auth=auth,
        )

    async def recover_group_for_founder(
        self,
        group_type: Union[GroupType, int],
        membership_id: int,
        membership_type: Union[BungieMembershipType, int],
        auth: Optional[AuthData] = None,
    ) -> GroupMembershipSearchResponse:
        """
        Allows a founder to manually recover a group they can see in game but not on bungie.net

        Args:
            group_type: Type of group the supplied member founded.
            membership_id: Membership ID to for which to find founded groups.
            membership_type: Membership type of the supplied membership ID.
            auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

        Returns:
            The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
        """

        response = await self._client.http.recover_group_for_founder(
            group_type=getattr(group_type, "value", group_type),
            membership_id=membership_id,
            membership_type=getattr(membership_type, "value", membership_type),
            auth=auth,
        )
        return await GroupMembershipSearchResponse.from_dict(
            data=response,
            client=self._client,
            group_type=group_type,
            membership_id=membership_id,
            membership_type=membership_type,
            auth=auth,
        )

    async def get_potential_groups_for_member(
        self,
        filter: Union[GroupPotentialMemberStatus, int],
        group_type: Union[GroupType, int],
        membership_id: int,
        membership_type: Union[BungieMembershipType, int],
        auth: Optional[AuthData] = None,
    ) -> GroupPotentialMembershipSearchResponse:
        """
        Get information about the groups that a given member has applied to or been invited to.

        Args:
            filter: Filter apply to list of potential joined groups.
            group_type: Type of group the supplied member applied.
            membership_id: Membership ID to for which to find applied groups.
            membership_type: Membership type of the supplied membership ID.
            auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

        Returns:
            The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
        """

        response = await self._client.http.get_potential_groups_for_member(
            filter=getattr(filter, "value", filter),
            group_type=getattr(group_type, "value", group_type),
            membership_id=membership_id,
            membership_type=getattr(membership_type, "value", membership_type),
            auth=auth,
        )
        return await GroupPotentialMembershipSearchResponse.from_dict(
            data=response,
            client=self._client,
            filter=filter,
            group_type=group_type,
            membership_id=membership_id,
            membership_type=membership_type,
            auth=auth,
        )

    async def individual_group_invite(
        self,
        data: GroupApplicationRequest,
        group_id: int,
        membership_id: int,
        membership_type: Union[BungieMembershipType, int],
        auth: AuthData,
    ) -> GroupApplicationResponse:
        """
        Invite a user to join this group.

        Warning: Requires Authentication.
            Required oauth2 scopes: AdminGroups

        Args:
            data: The required data for this request.
            group_id: ID of the group you would like to join.
            membership_id: Membership id of the account being invited.
            membership_type: MembershipType of the account being invited.
            auth: Authentication information.

        Returns:
            The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
        """

        response = await self._client.http.individual_group_invite(
            group_id=group_id,
            membership_id=membership_id,
            membership_type=getattr(membership_type, "value", membership_type),
            auth=auth,
            **data.to_dict(_return_to_bungie_case=False),
        )
        return await GroupApplicationResponse.from_dict(
            data=response,
            client=self._client,
            group_id=group_id,
            membership_id=membership_id,
            membership_type=membership_type,
            auth=auth,
        )

    async def individual_group_invite_cancel(
        self, group_id: int, membership_id: int, membership_type: Union[BungieMembershipType, int], auth: AuthData
    ) -> GroupApplicationResponse:
        """
        Cancels a pending invitation to join a group.

        Warning: Requires Authentication.
            Required oauth2 scopes: AdminGroups

        Args:
            group_id: ID of the group you would like to join.
            membership_id: Membership id of the account being cancelled.
            membership_type: MembershipType of the account being cancelled.
            auth: Authentication information.

        Returns:
            The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
        """

        response = await self._client.http.individual_group_invite_cancel(
            group_id=group_id,
            membership_id=membership_id,
            membership_type=getattr(membership_type, "value", membership_type),
            auth=auth,
        )
        return await GroupApplicationResponse.from_dict(
            data=response,
            client=self._client,
            group_id=group_id,
            membership_id=membership_id,
            membership_type=membership_type,
            auth=auth,
        )

abdicate_foundership(founder_id_new, group_id, membership_type, auth=None) async

An administrative method to allow the founder of a group or clan to give up their position to another admin permanently.

Parameters:

Name	Type	Description	Default
founder_id_new	int	The new founder for this group. Must already be a group admin.	required
group_id	int	The target group id.	required
membership_type	Union[BungieMembershipType, int]	Membership type of the provided founderIdNew.	required
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Returns:

Type	Description
bool	The model which is returned by bungie. General endpoint information.

Source code in src/bungio/api/bungie/group_v2.py

async def abdicate_foundership(
    self,
    founder_id_new: int,
    group_id: int,
    membership_type: Union[BungieMembershipType, int],
    auth: Optional[AuthData] = None,
) -> bool:
    """
    An administrative method to allow the founder of a group or clan to give up their position to another admin permanently.

    Args:
        founder_id_new: The new founder for this group. Must already be a group admin.
        group_id: The target group id.
        membership_type: Membership type of the provided founderIdNew.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Returns:
        The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
    """

    response = await self._client.http.abdicate_foundership(
        founder_id_new=founder_id_new,
        group_id=group_id,
        membership_type=getattr(membership_type, "value", membership_type),
        auth=auth,
    )
    return response["Response"]

add_optional_conversation(data, group_id, auth) async

Add a new optional conversation/chat channel. Requires admin permissions to the group.

Requires Authentication.

Required oauth2 scopes: AdminGroups

Parameters:

Name	Type	Description	Default
data	GroupOptionalConversationAddRequest	The required data for this request.	required
group_id	int	Group ID of the group to edit.	required
auth	AuthData	Authentication information.	required

Returns:

Type	Description
int	The model which is returned by bungie. General endpoint information.

Source code in src/bungio/api/bungie/group_v2.py

async def add_optional_conversation(
    self, data: GroupOptionalConversationAddRequest, group_id: int, auth: AuthData
) -> int:
    """
    Add a new optional conversation/chat channel. Requires admin permissions to the group.

    Warning: Requires Authentication.
        Required oauth2 scopes: AdminGroups

    Args:
        data: The required data for this request.
        group_id: Group ID of the group to edit.
        auth: Authentication information.

    Returns:
        The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
    """

    response = await self._client.http.add_optional_conversation(
        group_id=group_id, auth=auth, **data.to_dict(_return_to_bungie_case=False)
    )
    return response["Response"]

approve_all_pending(data, group_id, auth) async

Approve all of the pending users for the given group.

Requires Authentication.

Required oauth2 scopes: AdminGroups

Parameters:

Name	Type	Description	Default
data	GroupApplicationRequest	The required data for this request.	required
group_id	int	ID of the group.	required
auth	AuthData	Authentication information.	required

Returns:

Type	Description
list[EntityActionResult]	The model which is returned by bungie. General endpoint information.

Source code in src/bungio/api/bungie/group_v2.py

async def approve_all_pending(
    self, data: GroupApplicationRequest, group_id: int, auth: AuthData
) -> list[EntityActionResult]:
    """
    Approve all of the pending users for the given group.

    Warning: Requires Authentication.
        Required oauth2 scopes: AdminGroups

    Args:
        data: The required data for this request.
        group_id: ID of the group.
        auth: Authentication information.

    Returns:
        The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
    """

    response = await self._client.http.approve_all_pending(
        group_id=group_id, auth=auth, **data.to_dict(_return_to_bungie_case=False)
    )
    return [
        await EntityActionResult.from_dict(data=value, client=self._client, group_id=group_id, auth=auth)
        for value in response["Response"]
    ]

approve_pending(data, group_id, membership_id, membership_type, auth) async

Approve the given membershipId to join the group/clan as long as they have applied.

Requires Authentication.

Required oauth2 scopes: AdminGroups

Parameters:

Name	Type	Description	Default
data	GroupApplicationRequest	The required data for this request.	required
group_id	int	ID of the group.	required
membership_id	int	The membership id being approved.	required
membership_type	Union[BungieMembershipType, int]	Membership type of the supplied membership ID.	required
auth	AuthData	Authentication information.	required

Returns:

Type	Description
bool	The model which is returned by bungie. General endpoint information.

Source code in src/bungio/api/bungie/group_v2.py

async def approve_pending(
    self,
    data: GroupApplicationRequest,
    group_id: int,
    membership_id: int,
    membership_type: Union[BungieMembershipType, int],
    auth: AuthData,
) -> bool:
    """
    Approve the given membershipId to join the group/clan as long as they have applied.

    Warning: Requires Authentication.
        Required oauth2 scopes: AdminGroups

    Args:
        data: The required data for this request.
        group_id: ID of the group.
        membership_id: The membership id being approved.
        membership_type: Membership type of the supplied membership ID.
        auth: Authentication information.

    Returns:
        The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
    """

    response = await self._client.http.approve_pending(
        group_id=group_id,
        membership_id=membership_id,
        membership_type=getattr(membership_type, "value", membership_type),
        auth=auth,
        **data.to_dict(_return_to_bungie_case=False),
    )
    return response["Response"]

approve_pending_for_list(data, group_id, auth) async

Approve all of the pending users for the given group.

Requires Authentication.

Required oauth2 scopes: AdminGroups

Parameters:

Name	Type	Description	Default
data	GroupApplicationListRequest	The required data for this request.	required
group_id	int	ID of the group.	required
auth	AuthData	Authentication information.	required

Returns:

Type	Description
list[EntityActionResult]	The model which is returned by bungie. General endpoint information.

Source code in src/bungio/api/bungie/group_v2.py

async def approve_pending_for_list(
    self, data: GroupApplicationListRequest, group_id: int, auth: AuthData
) -> list[EntityActionResult]:
    """
    Approve all of the pending users for the given group.

    Warning: Requires Authentication.
        Required oauth2 scopes: AdminGroups

    Args:
        data: The required data for this request.
        group_id: ID of the group.
        auth: Authentication information.

    Returns:
        The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
    """

    response = await self._client.http.approve_pending_for_list(
        group_id=group_id, auth=auth, **data.to_dict(_return_to_bungie_case=False)
    )
    return [
        await EntityActionResult.from_dict(data=value, client=self._client, group_id=group_id, auth=auth)
        for value in response["Response"]
    ]

ban_member(data, group_id, membership_id, membership_type, auth) async

Bans the requested member from the requested group for the specified period of time.

Requires Authentication.

Required oauth2 scopes: AdminGroups

Parameters:

Name	Type	Description	Default
data	GroupBanRequest	The required data for this request.	required
group_id	int	Group ID that has the member to ban.	required
membership_id	int	Membership ID of the member to ban from the group.	required
membership_type	Union[BungieMembershipType, int]	Membership type of the provided membership ID.	required
auth	AuthData	Authentication information.	required

Returns:

Type	Description
int	The model which is returned by bungie. General endpoint information.

Source code in src/bungio/api/bungie/group_v2.py

async def ban_member(
    self,
    data: GroupBanRequest,
    group_id: int,
    membership_id: int,
    membership_type: Union[BungieMembershipType, int],
    auth: AuthData,
) -> int:
    """
    Bans the requested member from the requested group for the specified period of time.

    Warning: Requires Authentication.
        Required oauth2 scopes: AdminGroups

    Args:
        data: The required data for this request.
        group_id: Group ID that has the member to ban.
        membership_id: Membership ID of the member to ban from the group.
        membership_type: Membership type of the provided membership ID.
        auth: Authentication information.

    Returns:
        The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
    """

    response = await self._client.http.ban_member(
        group_id=group_id,
        membership_id=membership_id,
        membership_type=getattr(membership_type, "value", membership_type),
        auth=auth,
        **data.to_dict(_return_to_bungie_case=False),
    )
    return response["Response"]

deny_all_pending(data, group_id, auth) async

Deny all of the pending users for the given group.

Requires Authentication.

Required oauth2 scopes: AdminGroups

Parameters:

Name	Type	Description	Default
data	GroupApplicationRequest	The required data for this request.	required
group_id	int	ID of the group.	required
auth	AuthData	Authentication information.	required

Returns:

Type	Description
list[EntityActionResult]	The model which is returned by bungie. General endpoint information.

Source code in src/bungio/api/bungie/group_v2.py

async def deny_all_pending(
    self, data: GroupApplicationRequest, group_id: int, auth: AuthData
) -> list[EntityActionResult]:
    """
    Deny all of the pending users for the given group.

    Warning: Requires Authentication.
        Required oauth2 scopes: AdminGroups

    Args:
        data: The required data for this request.
        group_id: ID of the group.
        auth: Authentication information.

    Returns:
        The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
    """

    response = await self._client.http.deny_all_pending(
        group_id=group_id, auth=auth, **data.to_dict(_return_to_bungie_case=False)
    )
    return [
        await EntityActionResult.from_dict(data=value, client=self._client, group_id=group_id, auth=auth)
        for value in response["Response"]
    ]

deny_pending_for_list(data, group_id, auth) async

Deny all of the pending users for the given group that match the passed-in .

Requires Authentication.

Required oauth2 scopes: AdminGroups

Parameters:

Name	Type	Description	Default
data	GroupApplicationListRequest	The required data for this request.	required
group_id	int	ID of the group.	required
auth	AuthData	Authentication information.	required

Returns:

Type	Description
list[EntityActionResult]	The model which is returned by bungie. General endpoint information.

Source code in src/bungio/api/bungie/group_v2.py

async def deny_pending_for_list(
    self, data: GroupApplicationListRequest, group_id: int, auth: AuthData
) -> list[EntityActionResult]:
    """
    Deny all of the pending users for the given group that match the passed-in .

    Warning: Requires Authentication.
        Required oauth2 scopes: AdminGroups

    Args:
        data: The required data for this request.
        group_id: ID of the group.
        auth: Authentication information.

    Returns:
        The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
    """

    response = await self._client.http.deny_pending_for_list(
        group_id=group_id, auth=auth, **data.to_dict(_return_to_bungie_case=False)
    )
    return [
        await EntityActionResult.from_dict(data=value, client=self._client, group_id=group_id, auth=auth)
        for value in response["Response"]
    ]

edit_clan_banner(data, group_id, auth) async

Edit an existing group's clan banner. You must have suitable permissions in the group to perform this operation. All fields are required.

Requires Authentication.

Required oauth2 scopes: AdminGroups

Parameters:

Name	Type	Description	Default
data	ClanBanner	The required data for this request.	required
group_id	int	Group ID of the group to edit.	required
auth	AuthData	Authentication information.	required

Returns:

Type	Description
int	The model which is returned by bungie. General endpoint information.

Source code in src/bungio/api/bungie/group_v2.py

async def edit_clan_banner(self, data: ClanBanner, group_id: int, auth: AuthData) -> int:
    """
    Edit an existing group's clan banner. You must have suitable permissions in the group to perform this operation. All fields are required.

    Warning: Requires Authentication.
        Required oauth2 scopes: AdminGroups

    Args:
        data: The required data for this request.
        group_id: Group ID of the group to edit.
        auth: Authentication information.

    Returns:
        The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
    """

    response = await self._client.http.edit_clan_banner(
        group_id=group_id, auth=auth, **data.to_dict(_return_to_bungie_case=False)
    )
    return response["Response"]

edit_founder_options(data, group_id, auth) async

Edit group options only available to a founder. You must have suitable permissions in the group to perform this operation.

Requires Authentication.

Required oauth2 scopes: AdminGroups

Parameters:

Name	Type	Description	Default
data	GroupOptionsEditAction	The required data for this request.	required
group_id	int	Group ID of the group to edit.	required
auth	AuthData	Authentication information.	required

Returns:

Type	Description
int	The model which is returned by bungie. General endpoint information.

Source code in src/bungio/api/bungie/group_v2.py

async def edit_founder_options(self, data: GroupOptionsEditAction, group_id: int, auth: AuthData) -> int:
    """
    Edit group options only available to a founder. You must have suitable permissions in the group to perform this operation.

    Warning: Requires Authentication.
        Required oauth2 scopes: AdminGroups

    Args:
        data: The required data for this request.
        group_id: Group ID of the group to edit.
        auth: Authentication information.

    Returns:
        The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
    """

    response = await self._client.http.edit_founder_options(
        group_id=group_id, auth=auth, **data.to_dict(_return_to_bungie_case=False)
    )
    return response["Response"]

edit_group(data, group_id, auth) async

Edit an existing group. You must have suitable permissions in the group to perform this operation. This latest revision will only edit the fields you pass in - pass null for properties you want to leave unaltered.

Requires Authentication.

Required oauth2 scopes: AdminGroups

Parameters:

Name	Type	Description	Default
data	GroupEditAction	The required data for this request.	required
group_id	int	Group ID of the group to edit.	required
auth	AuthData	Authentication information.	required

Returns:

Type	Description
int	The model which is returned by bungie. General endpoint information.

Source code in src/bungio/api/bungie/group_v2.py

async def edit_group(self, data: GroupEditAction, group_id: int, auth: AuthData) -> int:
    """
    Edit an existing group. You must have suitable permissions in the group to perform this operation. This latest revision will only edit the fields you pass in - pass null for properties you want to leave unaltered.

    Warning: Requires Authentication.
        Required oauth2 scopes: AdminGroups

    Args:
        data: The required data for this request.
        group_id: Group ID of the group to edit.
        auth: Authentication information.

    Returns:
        The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
    """

    response = await self._client.http.edit_group(
        group_id=group_id, auth=auth, **data.to_dict(_return_to_bungie_case=False)
    )
    return response["Response"]

edit_group_membership(group_id, membership_id, membership_type, member_type, auth) async

Edit the membership type of a given member. You must have suitable permissions in the group to perform this operation.

Requires Authentication.

Required oauth2 scopes: AdminGroups

Parameters:

Name	Type	Description	Default
group_id	int	ID of the group to which the member belongs.	required
membership_id	int	Membership ID to modify.	required
membership_type	Union[BungieMembershipType, int]	Membership type of the provide membership ID.	required
member_type	Union[RuntimeGroupMemberType, int]	New membertype for the specified member.	required
auth	AuthData	Authentication information.	required

Returns:

Type	Description
int	The model which is returned by bungie. General endpoint information.

Source code in src/bungio/api/bungie/group_v2.py

async def edit_group_membership(
    self,
    group_id: int,
    membership_id: int,
    membership_type: Union[BungieMembershipType, int],
    member_type: Union[RuntimeGroupMemberType, int],
    auth: AuthData,
) -> int:
    """
    Edit the membership type of a given member. You must have suitable permissions in the group to perform this operation.

    Warning: Requires Authentication.
        Required oauth2 scopes: AdminGroups

    Args:
        group_id: ID of the group to which the member belongs.
        membership_id: Membership ID to modify.
        membership_type: Membership type of the provide membership ID.
        member_type: New membertype for the specified member.
        auth: Authentication information.

    Returns:
        The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
    """

    response = await self._client.http.edit_group_membership(
        group_id=group_id,
        membership_id=membership_id,
        membership_type=getattr(membership_type, "value", membership_type),
        member_type=getattr(member_type, "value", member_type),
        auth=auth,
    )
    return response["Response"]

edit_optional_conversation(data, conversation_id, group_id, auth) async

Edit the settings of an optional conversation/chat channel. Requires admin permissions to the group.

Requires Authentication.

Required oauth2 scopes: AdminGroups

Parameters:

Name	Type	Description	Default
data	GroupOptionalConversationEditRequest	The required data for this request.	required
conversation_id	int	Conversation Id of the channel being edited.	required
group_id	int	Group ID of the group to edit.	required
auth	AuthData	Authentication information.	required

Returns:

Type	Description
int	The model which is returned by bungie. General endpoint information.

Source code in src/bungio/api/bungie/group_v2.py

async def edit_optional_conversation(
    self, data: GroupOptionalConversationEditRequest, conversation_id: int, group_id: int, auth: AuthData
) -> int:
    """
    Edit the settings of an optional conversation/chat channel. Requires admin permissions to the group.

    Warning: Requires Authentication.
        Required oauth2 scopes: AdminGroups

    Args:
        data: The required data for this request.
        conversation_id: Conversation Id of the channel being edited.
        group_id: Group ID of the group to edit.
        auth: Authentication information.

    Returns:
        The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
    """

    response = await self._client.http.edit_optional_conversation(
        conversation_id=conversation_id, group_id=group_id, auth=auth, **data.to_dict(_return_to_bungie_case=False)
    )
    return response["Response"]

get_admins_and_founder_of_group(currentpage, group_id, auth=None) async

Get the list of members in a given group who are of admin level or higher.

Parameters:

Name	Type	Description	Default
currentpage	int	Page number (starting with 1). Each page has a fixed size of 50 items per page.	required
group_id	int	The ID of the group.	required
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Returns:

Type	Description
SearchResultOfGroupMember	The model which is returned by bungie. General endpoint information.

Source code in src/bungio/api/bungie/group_v2.py

async def get_admins_and_founder_of_group(
    self, currentpage: int, group_id: int, auth: Optional[AuthData] = None
) -> SearchResultOfGroupMember:
    """
    Get the list of members in a given group who are of admin level or higher.

    Args:
        currentpage: Page number (starting with 1). Each page has a fixed size of 50 items per page.
        group_id: The ID of the group.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Returns:
        The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
    """

    response = await self._client.http.get_admins_and_founder_of_group(
        currentpage=currentpage, group_id=group_id, auth=auth
    )
    return await SearchResultOfGroupMember.from_dict(
        data=response, client=self._client, currentpage=currentpage, group_id=group_id, auth=auth
    )

get_available_avatars(auth=None) async

Returns a list of all available group avatars for the signed-in user.

Parameters:

Name	Type	Description	Default
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Returns:

Type	Description
dict[int, str]	The model which is returned by bungie. General endpoint information.

Source code in src/bungio/api/bungie/group_v2.py

async def get_available_avatars(self, auth: Optional[AuthData] = None) -> dict[int, str]:
    """
    Returns a list of all available group avatars for the signed-in user.

    Args:
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Returns:
        The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
    """

    response = await self._client.http.get_available_avatars(auth=auth)
    return {key: value async for key, value in AllowAsyncIteration(response["Response"].items())}

get_available_themes(auth=None) async

Returns a list of all available group themes.

Parameters:

Name	Type	Description	Default
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Returns:

Type	Description
list[GroupTheme]	The model which is returned by bungie. General endpoint information.

Source code in src/bungio/api/bungie/group_v2.py

async def get_available_themes(self, auth: Optional[AuthData] = None) -> list[GroupTheme]:
    """
    Returns a list of all available group themes.

    Args:
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Returns:
        The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
    """

    response = await self._client.http.get_available_themes(auth=auth)
    return [
        await GroupTheme.from_dict(data=value, client=self._client, auth=auth) for value in response["Response"]
    ]

get_banned_members_of_group(currentpage, group_id, auth) async

Get the list of banned members in a given group. Only accessible to group Admins and above. Not applicable to all groups. Check group features.

Requires Authentication.

Required oauth2 scopes: AdminGroups

Parameters:

Name	Type	Description	Default
currentpage	int	Page number (starting with 1). Each page has a fixed size of 50 entries.	required
group_id	int	Group ID whose banned members you are fetching	required
auth	AuthData	Authentication information.	required

Returns:

Type	Description
SearchResultOfGroupBan	The model which is returned by bungie. General endpoint information.

Source code in src/bungio/api/bungie/group_v2.py

async def get_banned_members_of_group(
    self, currentpage: int, group_id: int, auth: AuthData
) -> SearchResultOfGroupBan:
    """
    Get the list of banned members in a given group. Only accessible to group Admins and above. Not applicable to all groups. Check group features.

    Warning: Requires Authentication.
        Required oauth2 scopes: AdminGroups

    Args:
        currentpage: Page number (starting with 1). Each page has a fixed size of 50 entries.
        group_id: Group ID whose banned members you are fetching
        auth: Authentication information.

    Returns:
        The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
    """

    response = await self._client.http.get_banned_members_of_group(
        currentpage=currentpage, group_id=group_id, auth=auth
    )
    return await SearchResultOfGroupBan.from_dict(
        data=response, client=self._client, currentpage=currentpage, group_id=group_id, auth=auth
    )

get_group(group_id, auth=None) async

Get information about a specific group of the given ID.

Parameters:

Name	Type	Description	Default
group_id	int	Requested group's id.	required
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Returns:

Type	Description
GroupResponse	The model which is returned by bungie. General endpoint information.

Source code in src/bungio/api/bungie/group_v2.py

async def get_group(self, group_id: int, auth: Optional[AuthData] = None) -> GroupResponse:
    """
    Get information about a specific group of the given ID.

    Args:
        group_id: Requested group's id.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Returns:
        The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
    """

    response = await self._client.http.get_group(group_id=group_id, auth=auth)
    return await GroupResponse.from_dict(data=response, client=self._client, group_id=group_id, auth=auth)

get_group_by_name(group_name, group_type, auth=None) async

Get information about a specific group with the given name and type.

Parameters:

Name	Type	Description	Default
group_name	str	Exact name of the group to find.	required
group_type	Union[GroupType, int]	Type of group to find.	required
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Returns:

Type	Description
GroupResponse	The model which is returned by bungie. General endpoint information.

Source code in src/bungio/api/bungie/group_v2.py

async def get_group_by_name(
    self, group_name: str, group_type: Union[GroupType, int], auth: Optional[AuthData] = None
) -> GroupResponse:
    """
    Get information about a specific group with the given name and type.

    Args:
        group_name: Exact name of the group to find.
        group_type: Type of group to find.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Returns:
        The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
    """

    response = await self._client.http.get_group_by_name(
        group_name=group_name, group_type=getattr(group_type, "value", group_type), auth=auth
    )
    return await GroupResponse.from_dict(
        data=response, client=self._client, group_name=group_name, group_type=group_type, auth=auth
    )

get_group_by_name_v2(data, auth=None) async

Get information about a specific group with the given name and type. The POST version.

Parameters:

Name	Type	Description	Default
data	GroupNameSearchRequest	The required data for this request.	required
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Returns:

Type	Description
GroupResponse	The model which is returned by bungie. General endpoint information.

Source code in src/bungio/api/bungie/group_v2.py

async def get_group_by_name_v2(
    self, data: GroupNameSearchRequest, auth: Optional[AuthData] = None
) -> GroupResponse:
    """
    Get information about a specific group with the given name and type. The POST version.

    Args:
        data: The required data for this request.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Returns:
        The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
    """

    response = await self._client.http.get_group_by_name_v2(auth=auth, **data.to_dict(_return_to_bungie_case=False))
    return await GroupResponse.from_dict(data=response, client=self._client, auth=auth)

get_group_edit_history(currentpage, group_id, auth) async

Get the list of edits made to a given group. Only accessible to group Admins and above.

Requires Authentication.

Required oauth2 scopes: AdminGroups

Parameters:

Name	Type	Description	Default
currentpage	int	Page number (starting with 1). Each page has a fixed size of 50 entries.	required
group_id	int	Group ID whose edit history you are fetching	required
auth	AuthData	Authentication information.	required

Returns:

Type	Description
SearchResultOfGroupEditHistory	The model which is returned by bungie. General endpoint information.

Source code in src/bungio/api/bungie/group_v2.py

async def get_group_edit_history(
    self, currentpage: int, group_id: int, auth: AuthData
) -> SearchResultOfGroupEditHistory:
    """
    Get the list of edits made to a given group. Only accessible to group Admins and above.

    Warning: Requires Authentication.
        Required oauth2 scopes: AdminGroups

    Args:
        currentpage: Page number (starting with 1). Each page has a fixed size of 50 entries.
        group_id: Group ID whose edit history you are fetching
        auth: Authentication information.

    Returns:
        The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
    """

    response = await self._client.http.get_group_edit_history(currentpage=currentpage, group_id=group_id, auth=auth)
    return await SearchResultOfGroupEditHistory.from_dict(
        data=response, client=self._client, currentpage=currentpage, group_id=group_id, auth=auth
    )

get_group_optional_conversations(group_id, auth=None) async

Gets a list of available optional conversation channels and their settings.

Parameters:

Name	Type	Description	Default
group_id	int	Requested group's id.	required
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Returns:

Type	Description
list[GroupOptionalConversation]	The model which is returned by bungie. General endpoint information.

Source code in src/bungio/api/bungie/group_v2.py

async def get_group_optional_conversations(
    self, group_id: int, auth: Optional[AuthData] = None
) -> list[GroupOptionalConversation]:
    """
    Gets a list of available optional conversation channels and their settings.

    Args:
        group_id: Requested group's id.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Returns:
        The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
    """

    response = await self._client.http.get_group_optional_conversations(group_id=group_id, auth=auth)
    return [
        await GroupOptionalConversation.from_dict(data=value, client=self._client, group_id=group_id, auth=auth)
        for value in response["Response"]
    ]

get_groups_for_member(filter, group_type, membership_id, membership_type, auth=None) async

Get information about the groups that a given member has joined.

Parameters:

Name	Type	Description	Default
filter	Union[GroupsForMemberFilter, int]	Filter apply to list of joined groups.	required
group_type	Union[GroupType, int]	Type of group the supplied member founded.	required
membership_id	int	Membership ID to for which to find founded groups.	required
membership_type	Union[BungieMembershipType, int]	Membership type of the supplied membership ID.	required
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Returns:

Type	Description
GetGroupsForMemberResponse	The model which is returned by bungie. General endpoint information.

Source code in src/bungio/api/bungie/group_v2.py

async def get_groups_for_member(
    self,
    filter: Union[GroupsForMemberFilter, int],
    group_type: Union[GroupType, int],
    membership_id: int,
    membership_type: Union[BungieMembershipType, int],
    auth: Optional[AuthData] = None,
) -> GetGroupsForMemberResponse:
    """
    Get information about the groups that a given member has joined.

    Args:
        filter: Filter apply to list of joined groups.
        group_type: Type of group the supplied member founded.
        membership_id: Membership ID to for which to find founded groups.
        membership_type: Membership type of the supplied membership ID.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Returns:
        The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
    """

    response = await self._client.http.get_groups_for_member(
        filter=getattr(filter, "value", filter),
        group_type=getattr(group_type, "value", group_type),
        membership_id=membership_id,
        membership_type=getattr(membership_type, "value", membership_type),
        auth=auth,
    )
    return await GetGroupsForMemberResponse.from_dict(
        data=response,
        client=self._client,
        filter=filter,
        group_type=group_type,
        membership_id=membership_id,
        membership_type=membership_type,
        auth=auth,
    )

get_invited_individuals(currentpage, group_id, auth) async

Get the list of users who have been invited into the group.

Requires Authentication.

Required oauth2 scopes: AdminGroups

Parameters:

Name	Type	Description	Default
currentpage	int	Page number (starting with 1). Each page has a fixed size of 50 items per page.	required
group_id	int	ID of the group.	required
auth	AuthData	Authentication information.	required

Returns:

Type	Description
SearchResultOfGroupMemberApplication	The model which is returned by bungie. General endpoint information.

Source code in src/bungio/api/bungie/group_v2.py

async def get_invited_individuals(
    self, currentpage: int, group_id: int, auth: AuthData
) -> SearchResultOfGroupMemberApplication:
    """
    Get the list of users who have been invited into the group.

    Warning: Requires Authentication.
        Required oauth2 scopes: AdminGroups

    Args:
        currentpage: Page number (starting with 1). Each page has a fixed size of 50 items per page.
        group_id: ID of the group.
        auth: Authentication information.

    Returns:
        The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
    """

    response = await self._client.http.get_invited_individuals(
        currentpage=currentpage, group_id=group_id, auth=auth
    )
    return await SearchResultOfGroupMemberApplication.from_dict(
        data=response, client=self._client, currentpage=currentpage, group_id=group_id, auth=auth
    )

get_members_of_group(currentpage, group_id, member_type=None, name_search=None, auth=None) async

Get the list of members in a given group.

Parameters:

Name	Type	Description	Default
currentpage	int	Page number (starting with 1). Each page has a fixed size of 50 items per page.	required
group_id	int	The ID of the group.	required
member_type	Optional[Union[RuntimeGroupMemberType, int]]	Filter out other member types. Use None for all members.	None
name_search	Optional[str]	The name fragment upon which a search should be executed for members with matching display or unique names.	None
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Returns:

Type	Description
SearchResultOfGroupMember	The model which is returned by bungie. General endpoint information.

Source code in src/bungio/api/bungie/group_v2.py

async def get_members_of_group(
    self,
    currentpage: int,
    group_id: int,
    member_type: Optional[Union[RuntimeGroupMemberType, int]] = None,
    name_search: Optional[str] = None,
    auth: Optional[AuthData] = None,
) -> SearchResultOfGroupMember:
    """
    Get the list of members in a given group.

    Args:
        currentpage: Page number (starting with 1). Each page has a fixed size of 50 items per page.
        group_id: The ID of the group.
        member_type: Filter out other member types. Use None for all members.
        name_search: The name fragment upon which a search should be executed for members with matching display or unique names.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Returns:
        The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
    """

    response = await self._client.http.get_members_of_group(
        currentpage=currentpage,
        group_id=group_id,
        member_type=getattr(member_type, "value", member_type) if member_type is not None else None,
        name_search=name_search if name_search is not None else None,
        auth=auth,
    )
    return await SearchResultOfGroupMember.from_dict(
        data=response,
        client=self._client,
        currentpage=currentpage,
        group_id=group_id,
        member_type=member_type,
        name_search=name_search,
        auth=auth,
    )

get_pending_memberships(currentpage, group_id, auth) async

Get the list of users who are awaiting a decision on their application to join a given group. Modified to include application info.

Requires Authentication.

Required oauth2 scopes: AdminGroups

Parameters:

Name	Type	Description	Default
currentpage	int	Page number (starting with 1). Each page has a fixed size of 50 items per page.	required
group_id	int	ID of the group.	required
auth	AuthData	Authentication information.	required

Returns:

Type	Description
SearchResultOfGroupMemberApplication	The model which is returned by bungie. General endpoint information.

Source code in src/bungio/api/bungie/group_v2.py

async def get_pending_memberships(
    self, currentpage: int, group_id: int, auth: AuthData
) -> SearchResultOfGroupMemberApplication:
    """
    Get the list of users who are awaiting a decision on their application to join a given group. Modified to include application info.

    Warning: Requires Authentication.
        Required oauth2 scopes: AdminGroups

    Args:
        currentpage: Page number (starting with 1). Each page has a fixed size of 50 items per page.
        group_id: ID of the group.
        auth: Authentication information.

    Returns:
        The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
    """

    response = await self._client.http.get_pending_memberships(
        currentpage=currentpage, group_id=group_id, auth=auth
    )
    return await SearchResultOfGroupMemberApplication.from_dict(
        data=response, client=self._client, currentpage=currentpage, group_id=group_id, auth=auth
    )

get_potential_groups_for_member(filter, group_type, membership_id, membership_type, auth=None) async

Get information about the groups that a given member has applied to or been invited to.

Parameters:

Name	Type	Description	Default
filter	Union[GroupPotentialMemberStatus, int]	Filter apply to list of potential joined groups.	required
group_type	Union[GroupType, int]	Type of group the supplied member applied.	required
membership_id	int	Membership ID to for which to find applied groups.	required
membership_type	Union[BungieMembershipType, int]	Membership type of the supplied membership ID.	required
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Returns:

Type	Description
GroupPotentialMembershipSearchResponse	The model which is returned by bungie. General endpoint information.

Source code in src/bungio/api/bungie/group_v2.py

async def get_potential_groups_for_member(
    self,
    filter: Union[GroupPotentialMemberStatus, int],
    group_type: Union[GroupType, int],
    membership_id: int,
    membership_type: Union[BungieMembershipType, int],
    auth: Optional[AuthData] = None,
) -> GroupPotentialMembershipSearchResponse:
    """
    Get information about the groups that a given member has applied to or been invited to.

    Args:
        filter: Filter apply to list of potential joined groups.
        group_type: Type of group the supplied member applied.
        membership_id: Membership ID to for which to find applied groups.
        membership_type: Membership type of the supplied membership ID.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Returns:
        The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
    """

    response = await self._client.http.get_potential_groups_for_member(
        filter=getattr(filter, "value", filter),
        group_type=getattr(group_type, "value", group_type),
        membership_id=membership_id,
        membership_type=getattr(membership_type, "value", membership_type),
        auth=auth,
    )
    return await GroupPotentialMembershipSearchResponse.from_dict(
        data=response,
        client=self._client,
        filter=filter,
        group_type=group_type,
        membership_id=membership_id,
        membership_type=membership_type,
        auth=auth,
    )

get_recommended_groups(create_date_range, group_type, auth) async

Gets groups recommended for you based on the groups to whom those you follow belong.

Requires Authentication.

Required oauth2 scopes: ReadGroups

Parameters:

Name	Type	Description	Default
create_date_range	Union[GroupDateRange, int]	Requested range in which to pull recommended groups	required
group_type	Union[GroupType, int]	Type of groups requested	required
auth	AuthData	Authentication information.	required

Returns:

Type	Description
list[GroupV2Card]	The model which is returned by bungie. General endpoint information.

Source code in src/bungio/api/bungie/group_v2.py

async def get_recommended_groups(
    self, create_date_range: Union[GroupDateRange, int], group_type: Union[GroupType, int], auth: AuthData
) -> list[GroupV2Card]:
    """
    Gets groups recommended for you based on the groups to whom those you follow belong.

    Warning: Requires Authentication.
        Required oauth2 scopes: ReadGroups

    Args:
        create_date_range: Requested range in which to pull recommended groups
        group_type: Type of groups requested
        auth: Authentication information.

    Returns:
        The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
    """

    response = await self._client.http.get_recommended_groups(
        create_date_range=getattr(create_date_range, "value", create_date_range),
        group_type=getattr(group_type, "value", group_type),
        auth=auth,
    )
    return [
        await GroupV2Card.from_dict(
            data=value, client=self._client, create_date_range=create_date_range, group_type=group_type, auth=auth
        )
        for value in response["Response"]
    ]

get_user_clan_invite_setting(m_type, auth) async

Gets the state of the user's clan invite preferences for a particular membership type - true if they wish to be invited to clans, false otherwise.

Requires Authentication.

Required oauth2 scopes: ReadUserData

Parameters:

Name	Type	Description	Default
m_type	Union[BungieMembershipType, int]	The Destiny membership type of the account we wish to access settings.	required
auth	AuthData	Authentication information.	required

Returns:

Type	Description
bool	The model which is returned by bungie. General endpoint information.

Source code in src/bungio/api/bungie/group_v2.py

async def get_user_clan_invite_setting(self, m_type: Union[BungieMembershipType, int], auth: AuthData) -> bool:
    """
    Gets the state of the user's clan invite preferences for a particular membership type - true if they wish to be invited to clans, false otherwise.

    Warning: Requires Authentication.
        Required oauth2 scopes: ReadUserData

    Args:
        m_type: The Destiny membership type of the account we wish to access settings.
        auth: Authentication information.

    Returns:
        The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
    """

    response = await self._client.http.get_user_clan_invite_setting(
        m_type=getattr(m_type, "value", m_type), auth=auth
    )
    return response["Response"]

group_search(data, auth=None) async

Search for Groups.

Parameters:

Name	Type	Description	Default
data	GroupQuery	The required data for this request.	required
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Returns:

Type	Description
GroupSearchResponse	The model which is returned by bungie. General endpoint information.

Source code in src/bungio/api/bungie/group_v2.py

async def group_search(self, data: GroupQuery, auth: Optional[AuthData] = None) -> GroupSearchResponse:
    """
    Search for Groups.

    Args:
        data: The required data for this request.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Returns:
        The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
    """

    response = await self._client.http.group_search(auth=auth, **data.to_dict(_return_to_bungie_case=False))
    return await GroupSearchResponse.from_dict(data=response, client=self._client, auth=auth)

individual_group_invite(data, group_id, membership_id, membership_type, auth) async

Invite a user to join this group.

Requires Authentication.

Required oauth2 scopes: AdminGroups

Parameters:

Name	Type	Description	Default
data	GroupApplicationRequest	The required data for this request.	required
group_id	int	ID of the group you would like to join.	required
membership_id	int	Membership id of the account being invited.	required
membership_type	Union[BungieMembershipType, int]	MembershipType of the account being invited.	required
auth	AuthData	Authentication information.	required

Returns:

Type	Description
GroupApplicationResponse	The model which is returned by bungie. General endpoint information.

Source code in src/bungio/api/bungie/group_v2.py

async def individual_group_invite(
    self,
    data: GroupApplicationRequest,
    group_id: int,
    membership_id: int,
    membership_type: Union[BungieMembershipType, int],
    auth: AuthData,
) -> GroupApplicationResponse:
    """
    Invite a user to join this group.

    Warning: Requires Authentication.
        Required oauth2 scopes: AdminGroups

    Args:
        data: The required data for this request.
        group_id: ID of the group you would like to join.
        membership_id: Membership id of the account being invited.
        membership_type: MembershipType of the account being invited.
        auth: Authentication information.

    Returns:
        The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
    """

    response = await self._client.http.individual_group_invite(
        group_id=group_id,
        membership_id=membership_id,
        membership_type=getattr(membership_type, "value", membership_type),
        auth=auth,
        **data.to_dict(_return_to_bungie_case=False),
    )
    return await GroupApplicationResponse.from_dict(
        data=response,
        client=self._client,
        group_id=group_id,
        membership_id=membership_id,
        membership_type=membership_type,
        auth=auth,
    )

individual_group_invite_cancel(group_id, membership_id, membership_type, auth) async

Cancels a pending invitation to join a group.

Requires Authentication.

Required oauth2 scopes: AdminGroups

Parameters:

Name	Type	Description	Default
group_id	int	ID of the group you would like to join.	required
membership_id	int	Membership id of the account being cancelled.	required
membership_type	Union[BungieMembershipType, int]	MembershipType of the account being cancelled.	required
auth	AuthData	Authentication information.	required

Returns:

Type	Description
GroupApplicationResponse	The model which is returned by bungie. General endpoint information.

Source code in src/bungio/api/bungie/group_v2.py

async def individual_group_invite_cancel(
    self, group_id: int, membership_id: int, membership_type: Union[BungieMembershipType, int], auth: AuthData
) -> GroupApplicationResponse:
    """
    Cancels a pending invitation to join a group.

    Warning: Requires Authentication.
        Required oauth2 scopes: AdminGroups

    Args:
        group_id: ID of the group you would like to join.
        membership_id: Membership id of the account being cancelled.
        membership_type: MembershipType of the account being cancelled.
        auth: Authentication information.

    Returns:
        The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
    """

    response = await self._client.http.individual_group_invite_cancel(
        group_id=group_id,
        membership_id=membership_id,
        membership_type=getattr(membership_type, "value", membership_type),
        auth=auth,
    )
    return await GroupApplicationResponse.from_dict(
        data=response,
        client=self._client,
        group_id=group_id,
        membership_id=membership_id,
        membership_type=membership_type,
        auth=auth,
    )

kick_member(group_id, membership_id, membership_type, auth) async

Kick a member from the given group, forcing them to reapply if they wish to re-join the group. You must have suitable permissions in the group to perform this operation.

Requires Authentication.

Required oauth2 scopes: AdminGroups

Parameters:

Name	Type	Description	Default
group_id	int	Group ID to kick the user from.	required
membership_id	int	Membership ID to kick.	required
membership_type	Union[BungieMembershipType, int]	Membership type of the provided membership ID.	required
auth	AuthData	Authentication information.	required

Returns:

Type	Description
GroupMemberLeaveResult	The model which is returned by bungie. General endpoint information.

Source code in src/bungio/api/bungie/group_v2.py

async def kick_member(
    self, group_id: int, membership_id: int, membership_type: Union[BungieMembershipType, int], auth: AuthData
) -> GroupMemberLeaveResult:
    """
    Kick a member from the given group, forcing them to reapply if they wish to re-join the group. You must have suitable permissions in the group to perform this operation.

    Warning: Requires Authentication.
        Required oauth2 scopes: AdminGroups

    Args:
        group_id: Group ID to kick the user from.
        membership_id: Membership ID to kick.
        membership_type: Membership type of the provided membership ID.
        auth: Authentication information.

    Returns:
        The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
    """

    response = await self._client.http.kick_member(
        group_id=group_id,
        membership_id=membership_id,
        membership_type=getattr(membership_type, "value", membership_type),
        auth=auth,
    )
    return await GroupMemberLeaveResult.from_dict(
        data=response,
        client=self._client,
        group_id=group_id,
        membership_id=membership_id,
        membership_type=membership_type,
        auth=auth,
    )

recover_group_for_founder(group_type, membership_id, membership_type, auth=None) async

Allows a founder to manually recover a group they can see in game but not on bungie.net

Parameters:

Name	Type	Description	Default
group_type	Union[GroupType, int]	Type of group the supplied member founded.	required
membership_id	int	Membership ID to for which to find founded groups.	required
membership_type	Union[BungieMembershipType, int]	Membership type of the supplied membership ID.	required
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Returns:

Type	Description
GroupMembershipSearchResponse	The model which is returned by bungie. General endpoint information.

Source code in src/bungio/api/bungie/group_v2.py

async def recover_group_for_founder(
    self,
    group_type: Union[GroupType, int],
    membership_id: int,
    membership_type: Union[BungieMembershipType, int],
    auth: Optional[AuthData] = None,
) -> GroupMembershipSearchResponse:
    """
    Allows a founder to manually recover a group they can see in game but not on bungie.net

    Args:
        group_type: Type of group the supplied member founded.
        membership_id: Membership ID to for which to find founded groups.
        membership_type: Membership type of the supplied membership ID.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Returns:
        The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
    """

    response = await self._client.http.recover_group_for_founder(
        group_type=getattr(group_type, "value", group_type),
        membership_id=membership_id,
        membership_type=getattr(membership_type, "value", membership_type),
        auth=auth,
    )
    return await GroupMembershipSearchResponse.from_dict(
        data=response,
        client=self._client,
        group_type=group_type,
        membership_id=membership_id,
        membership_type=membership_type,
        auth=auth,
    )

unban_member(group_id, membership_id, membership_type, auth) async

Unbans the requested member, allowing them to re-apply for membership.

Requires Authentication.

Required oauth2 scopes: AdminGroups

Parameters:

Name	Type	Description	Default
group_id	int		required
membership_id	int	Membership ID of the member to unban from the group	required
membership_type	Union[BungieMembershipType, int]	Membership type of the provided membership ID.	required
auth	AuthData	Authentication information.	required

Returns:

Type	Description
int	The model which is returned by bungie. General endpoint information.

Source code in src/bungio/api/bungie/group_v2.py

async def unban_member(
    self, group_id: int, membership_id: int, membership_type: Union[BungieMembershipType, int], auth: AuthData
) -> int:
    """
    Unbans the requested member, allowing them to re-apply for membership.

    Warning: Requires Authentication.
        Required oauth2 scopes: AdminGroups

    Args:
        group_id:
        membership_id: Membership ID of the member to unban from the group
        membership_type: Membership type of the provided membership ID.
        auth: Authentication information.

    Returns:
        The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
    """

    response = await self._client.http.unban_member(
        group_id=group_id,
        membership_id=membership_id,
        membership_type=getattr(membership_type, "value", membership_type),
        auth=auth,
    )
    return response["Response"]