Fireteam Routes

FireteamRouteInterface

Bases: ClientMixin

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

@custom_define()
class FireteamRouteInterface(ClientMixin):
    async def get_active_private_clan_fireteam_count(self, group_id: int, auth: AuthData) -> int:
        """
        Gets a count of all active non-public fireteams for the specified clan. Maximum value returned is 25.

        Warning: Requires Authentication.
            Required oauth2 scopes: ReadGroups

        Args:
            group_id: The group id of the clan.
            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_active_private_clan_fireteam_count(group_id=group_id, auth=auth)
        return response["Response"]

    async def get_available_clan_fireteams(
        self,
        activity_type: int,
        date_range: Union[FireteamDateRange, int],
        group_id: int,
        page: int,
        platform: Union[FireteamPlatform, int],
        public_only: Union[FireteamPublicSearchOption, int],
        slot_filter: Union[FireteamSlotSearch, int],
        auth: AuthData,
        exclude_immediate: Optional[bool] = None,
        lang_filter: Optional[str] = None,
    ) -> SearchResultOfFireteamSummary:
        """
        Gets a listing of all of this clan's fireteams that are have available slots. Caller is not checked for join criteria so caching is maximized.

        Warning: Requires Authentication.
            Required oauth2 scopes: ReadGroups

        Args:
            activity_type: The activity type to filter by.
            date_range: The date range to grab available fireteams.
            group_id: The group id of the clan.
            page: Zero based page
            platform: The platform filter.
            public_only: Determines public/private filtering.
            slot_filter: Filters based on available slots
            auth: Authentication information.
            exclude_immediate: If you wish the result to exclude immediate fireteams, set this to true. Immediate-only can be forced using the dateRange enum.
            lang_filter: An optional language filter.

        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_clan_fireteams(
            activity_type=activity_type,
            date_range=getattr(date_range, "value", date_range),
            group_id=group_id,
            page=page,
            platform=getattr(platform, "value", platform),
            public_only=getattr(public_only, "value", public_only),
            slot_filter=getattr(slot_filter, "value", slot_filter),
            auth=auth,
            exclude_immediate=exclude_immediate if exclude_immediate is not None else None,
            lang_filter=lang_filter if lang_filter is not None else None,
        )
        return await SearchResultOfFireteamSummary.from_dict(
            data=response,
            client=self._client,
            activity_type=activity_type,
            date_range=date_range,
            group_id=group_id,
            page=page,
            platform=platform,
            public_only=public_only,
            slot_filter=slot_filter,
            auth=auth,
            exclude_immediate=exclude_immediate,
            lang_filter=lang_filter,
        )

    async def search_public_available_clan_fireteams(
        self,
        activity_type: int,
        date_range: Union[FireteamDateRange, int],
        page: int,
        platform: Union[FireteamPlatform, int],
        slot_filter: Union[FireteamSlotSearch, int],
        auth: AuthData,
        exclude_immediate: Optional[bool] = None,
        lang_filter: Optional[str] = None,
    ) -> SearchResultOfFireteamSummary:
        """
        Gets a listing of all public fireteams starting now with open slots. Caller is not checked for join criteria so caching is maximized.

        Warning: Requires Authentication.
            Required oauth2 scopes: ReadGroups

        Args:
            activity_type: The activity type to filter by.
            date_range: The date range to grab available fireteams.
            page: Zero based page
            platform: The platform filter.
            slot_filter: Filters based on available slots
            auth: Authentication information.
            exclude_immediate: If you wish the result to exclude immediate fireteams, set this to true. Immediate-only can be forced using the dateRange enum.
            lang_filter: An optional language filter.

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

        response = await self._client.http.search_public_available_clan_fireteams(
            activity_type=activity_type,
            date_range=getattr(date_range, "value", date_range),
            page=page,
            platform=getattr(platform, "value", platform),
            slot_filter=getattr(slot_filter, "value", slot_filter),
            auth=auth,
            exclude_immediate=exclude_immediate if exclude_immediate is not None else None,
            lang_filter=lang_filter if lang_filter is not None else None,
        )
        return await SearchResultOfFireteamSummary.from_dict(
            data=response,
            client=self._client,
            activity_type=activity_type,
            date_range=date_range,
            page=page,
            platform=platform,
            slot_filter=slot_filter,
            auth=auth,
            exclude_immediate=exclude_immediate,
            lang_filter=lang_filter,
        )

    async def get_my_clan_fireteams(
        self,
        group_id: int,
        include_closed: bool,
        page: int,
        platform: Union[FireteamPlatform, int],
        auth: AuthData,
        group_filter: Optional[bool] = None,
        lang_filter: Optional[str] = None,
    ) -> SearchResultOfFireteamResponse:
        """
        Gets a listing of all fireteams that caller is an applicant, a member, or an alternate of.

        Warning: Requires Authentication.
            Required oauth2 scopes: ReadGroups

        Args:
            group_id: The group id of the clan. (This parameter is ignored unless the optional query parameter groupFilter is true).
            include_closed: If true, return fireteams that have been closed.
            page: Deprecated parameter, ignored.
            platform: The platform filter.
            auth: Authentication information.
            group_filter: If true, filter by clan. Otherwise, ignore the clan and show all of the user's fireteams.
            lang_filter: An optional language filter.

        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_my_clan_fireteams(
            group_id=group_id,
            include_closed=include_closed,
            page=page,
            platform=getattr(platform, "value", platform),
            auth=auth,
            group_filter=group_filter if group_filter is not None else None,
            lang_filter=lang_filter if lang_filter is not None else None,
        )
        return await SearchResultOfFireteamResponse.from_dict(
            data=response,
            client=self._client,
            group_id=group_id,
            include_closed=include_closed,
            page=page,
            platform=platform,
            auth=auth,
            group_filter=group_filter,
            lang_filter=lang_filter,
        )

    async def get_clan_fireteam(self, fireteam_id: int, group_id: int, auth: AuthData) -> FireteamResponse:
        """
        Gets a specific fireteam.

        Warning: Requires Authentication.
            Required oauth2 scopes: ReadGroups

        Args:
            fireteam_id: The unique id of the fireteam.
            group_id: The group id of the clan.
            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_clan_fireteam(fireteam_id=fireteam_id, group_id=group_id, auth=auth)
        return await FireteamResponse.from_dict(
            data=response, client=self._client, fireteam_id=fireteam_id, group_id=group_id, auth=auth
        )

get_active_private_clan_fireteam_count(group_id, auth) async

Gets a count of all active non-public fireteams for the specified clan. Maximum value returned is 25.

Requires Authentication.

Required oauth2 scopes: ReadGroups

Parameters:

Name	Type	Description	Default
group_id	int	The group id of the clan.	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/fireteam.py

async def get_active_private_clan_fireteam_count(self, group_id: int, auth: AuthData) -> int:
    """
    Gets a count of all active non-public fireteams for the specified clan. Maximum value returned is 25.

    Warning: Requires Authentication.
        Required oauth2 scopes: ReadGroups

    Args:
        group_id: The group id of the clan.
        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_active_private_clan_fireteam_count(group_id=group_id, auth=auth)
    return response["Response"]

get_available_clan_fireteams(activity_type, date_range, group_id, page, platform, public_only, slot_filter, auth, exclude_immediate=None, lang_filter=None) async

Gets a listing of all of this clan's fireteams that are have available slots. Caller is not checked for join criteria so caching is maximized.

Requires Authentication.

Required oauth2 scopes: ReadGroups

Parameters:

Name	Type	Description	Default
activity_type	int	The activity type to filter by.	required
date_range	Union[FireteamDateRange, int]	The date range to grab available fireteams.	required
group_id	int	The group id of the clan.	required
page	int	Zero based page	required
platform	Union[FireteamPlatform, int]	The platform filter.	required
public_only	Union[FireteamPublicSearchOption, int]	Determines public/private filtering.	required
slot_filter	Union[FireteamSlotSearch, int]	Filters based on available slots	required
auth	AuthData	Authentication information.	required
exclude_immediate	Optional[bool]	If you wish the result to exclude immediate fireteams, set this to true. Immediate-only can be forced using the dateRange enum.	None
lang_filter	Optional[str]	An optional language filter.	None

Returns:

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

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

async def get_available_clan_fireteams(
    self,
    activity_type: int,
    date_range: Union[FireteamDateRange, int],
    group_id: int,
    page: int,
    platform: Union[FireteamPlatform, int],
    public_only: Union[FireteamPublicSearchOption, int],
    slot_filter: Union[FireteamSlotSearch, int],
    auth: AuthData,
    exclude_immediate: Optional[bool] = None,
    lang_filter: Optional[str] = None,
) -> SearchResultOfFireteamSummary:
    """
    Gets a listing of all of this clan's fireteams that are have available slots. Caller is not checked for join criteria so caching is maximized.

    Warning: Requires Authentication.
        Required oauth2 scopes: ReadGroups

    Args:
        activity_type: The activity type to filter by.
        date_range: The date range to grab available fireteams.
        group_id: The group id of the clan.
        page: Zero based page
        platform: The platform filter.
        public_only: Determines public/private filtering.
        slot_filter: Filters based on available slots
        auth: Authentication information.
        exclude_immediate: If you wish the result to exclude immediate fireteams, set this to true. Immediate-only can be forced using the dateRange enum.
        lang_filter: An optional language filter.

    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_clan_fireteams(
        activity_type=activity_type,
        date_range=getattr(date_range, "value", date_range),
        group_id=group_id,
        page=page,
        platform=getattr(platform, "value", platform),
        public_only=getattr(public_only, "value", public_only),
        slot_filter=getattr(slot_filter, "value", slot_filter),
        auth=auth,
        exclude_immediate=exclude_immediate if exclude_immediate is not None else None,
        lang_filter=lang_filter if lang_filter is not None else None,
    )
    return await SearchResultOfFireteamSummary.from_dict(
        data=response,
        client=self._client,
        activity_type=activity_type,
        date_range=date_range,
        group_id=group_id,
        page=page,
        platform=platform,
        public_only=public_only,
        slot_filter=slot_filter,
        auth=auth,
        exclude_immediate=exclude_immediate,
        lang_filter=lang_filter,
    )

get_clan_fireteam(fireteam_id, group_id, auth) async

Gets a specific fireteam.

Requires Authentication.

Required oauth2 scopes: ReadGroups

Parameters:

Name	Type	Description	Default
fireteam_id	int	The unique id of the fireteam.	required
group_id	int	The group id of the clan.	required
auth	AuthData	Authentication information.	required

Returns:

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

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

async def get_clan_fireteam(self, fireteam_id: int, group_id: int, auth: AuthData) -> FireteamResponse:
    """
    Gets a specific fireteam.

    Warning: Requires Authentication.
        Required oauth2 scopes: ReadGroups

    Args:
        fireteam_id: The unique id of the fireteam.
        group_id: The group id of the clan.
        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_clan_fireteam(fireteam_id=fireteam_id, group_id=group_id, auth=auth)
    return await FireteamResponse.from_dict(
        data=response, client=self._client, fireteam_id=fireteam_id, group_id=group_id, auth=auth
    )

get_my_clan_fireteams(group_id, include_closed, page, platform, auth, group_filter=None, lang_filter=None) async

Gets a listing of all fireteams that caller is an applicant, a member, or an alternate of.

Requires Authentication.

Required oauth2 scopes: ReadGroups

Parameters:

Name	Type	Description	Default
group_id	int	The group id of the clan. (This parameter is ignored unless the optional query parameter groupFilter is true).	required
include_closed	bool	If true, return fireteams that have been closed.	required
page	int	Deprecated parameter, ignored.	required
platform	Union[FireteamPlatform, int]	The platform filter.	required
auth	AuthData	Authentication information.	required
group_filter	Optional[bool]	If true, filter by clan. Otherwise, ignore the clan and show all of the user's fireteams.	None
lang_filter	Optional[str]	An optional language filter.	None

Returns:

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

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

async def get_my_clan_fireteams(
    self,
    group_id: int,
    include_closed: bool,
    page: int,
    platform: Union[FireteamPlatform, int],
    auth: AuthData,
    group_filter: Optional[bool] = None,
    lang_filter: Optional[str] = None,
) -> SearchResultOfFireteamResponse:
    """
    Gets a listing of all fireteams that caller is an applicant, a member, or an alternate of.

    Warning: Requires Authentication.
        Required oauth2 scopes: ReadGroups

    Args:
        group_id: The group id of the clan. (This parameter is ignored unless the optional query parameter groupFilter is true).
        include_closed: If true, return fireteams that have been closed.
        page: Deprecated parameter, ignored.
        platform: The platform filter.
        auth: Authentication information.
        group_filter: If true, filter by clan. Otherwise, ignore the clan and show all of the user's fireteams.
        lang_filter: An optional language filter.

    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_my_clan_fireteams(
        group_id=group_id,
        include_closed=include_closed,
        page=page,
        platform=getattr(platform, "value", platform),
        auth=auth,
        group_filter=group_filter if group_filter is not None else None,
        lang_filter=lang_filter if lang_filter is not None else None,
    )
    return await SearchResultOfFireteamResponse.from_dict(
        data=response,
        client=self._client,
        group_id=group_id,
        include_closed=include_closed,
        page=page,
        platform=platform,
        auth=auth,
        group_filter=group_filter,
        lang_filter=lang_filter,
    )

search_public_available_clan_fireteams(activity_type, date_range, page, platform, slot_filter, auth, exclude_immediate=None, lang_filter=None) async

Gets a listing of all public fireteams starting now with open slots. Caller is not checked for join criteria so caching is maximized.

Requires Authentication.

Required oauth2 scopes: ReadGroups

Parameters:

Name	Type	Description	Default
activity_type	int	The activity type to filter by.	required
date_range	Union[FireteamDateRange, int]	The date range to grab available fireteams.	required
page	int	Zero based page	required
platform	Union[FireteamPlatform, int]	The platform filter.	required
slot_filter	Union[FireteamSlotSearch, int]	Filters based on available slots	required
auth	AuthData	Authentication information.	required
exclude_immediate	Optional[bool]	If you wish the result to exclude immediate fireteams, set this to true. Immediate-only can be forced using the dateRange enum.	None
lang_filter	Optional[str]	An optional language filter.	None

Returns:

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

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

async def search_public_available_clan_fireteams(
    self,
    activity_type: int,
    date_range: Union[FireteamDateRange, int],
    page: int,
    platform: Union[FireteamPlatform, int],
    slot_filter: Union[FireteamSlotSearch, int],
    auth: AuthData,
    exclude_immediate: Optional[bool] = None,
    lang_filter: Optional[str] = None,
) -> SearchResultOfFireteamSummary:
    """
    Gets a listing of all public fireteams starting now with open slots. Caller is not checked for join criteria so caching is maximized.

    Warning: Requires Authentication.
        Required oauth2 scopes: ReadGroups

    Args:
        activity_type: The activity type to filter by.
        date_range: The date range to grab available fireteams.
        page: Zero based page
        platform: The platform filter.
        slot_filter: Filters based on available slots
        auth: Authentication information.
        exclude_immediate: If you wish the result to exclude immediate fireteams, set this to true. Immediate-only can be forced using the dateRange enum.
        lang_filter: An optional language filter.

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

    response = await self._client.http.search_public_available_clan_fireteams(
        activity_type=activity_type,
        date_range=getattr(date_range, "value", date_range),
        page=page,
        platform=getattr(platform, "value", platform),
        slot_filter=getattr(slot_filter, "value", slot_filter),
        auth=auth,
        exclude_immediate=exclude_immediate if exclude_immediate is not None else None,
        lang_filter=lang_filter if lang_filter is not None else None,
    )
    return await SearchResultOfFireteamSummary.from_dict(
        data=response,
        client=self._client,
        activity_type=activity_type,
        date_range=date_range,
        page=page,
        platform=platform,
        slot_filter=slot_filter,
        auth=auth,
        exclude_immediate=exclude_immediate,
        lang_filter=lang_filter,
    )