Skip to content

Clan Model

DestinyClan

Bases: DestinyClanMixin

A representation of a Destiny 2 clan

Attributes:

Name Type Description
group_id int

The clan's id
Source code in src/bungio/models/basic/clan.py 
 7
 8
 9
10
11
12
13
14
15
16
@custom_define()
class DestinyClan(DestinyClanMixin):
    """
    A representation of a Destiny 2 clan

    Attributes:
        group_id: The clan's id
    """

    group_id: int = custom_field()

_fuzzy_getattr(name)

Returns the objs attribute that fully matches the name, or if that does not exist, the first attribute that includes the name

Parameters:

Name Type Description Default
name str

The name to match

 required

Raises:

Type Description
KeyError

If no match is found

Returns:

Type Description
Any

The attribute value
Source code in src/bungio/models/base.py 
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
def _fuzzy_getattr(self, name: str) -> Any:
    """
    Returns the objs attribute that fully matches the name, or if that does not exist, the first attribute that includes the name

    Args:
        name: The name to match

    Raises:
        KeyError: If no match is found

    Returns:
        The attribute value
    """

    try:
        found_attr = getattr(self, name)
        return found_attr
    except AttributeError:
        for attr_name in self.__dir__():
            if name in attr_name:
                return getattr(self, attr_name)
        raise KeyError(f"`{name}` not found in `{self.__dir__()}`")

abdicate_foundership(founder_id_new, 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
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/models/mixins/clan.py 
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
async def abdicate_foundership(
    self,
    founder_id_new: 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.
        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)
    """

    return await self._client.api.abdicate_foundership(
        founder_id_new=founder_id_new,
        group_id=self._fuzzy_getattr("group_id"),
        membership_type=membership_type,
        auth=auth,
    )

add_optional_conversation(data, 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
auth AuthData

Authentication information.

 required

Returns:

Type Description
int

The model which is returned by bungie. General endpoint information.
Source code in src/bungio/models/mixins/clan.py 
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
async def add_optional_conversation(self, data: "GroupOptionalConversationAddRequest", 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.
        auth: Authentication information.

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

    return await self._client.api.add_optional_conversation(
        data=data, group_id=self._fuzzy_getattr("group_id"), auth=auth
    )

approve_all_pending(data, 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
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/models/mixins/clan.py 
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
async def approve_all_pending(
    self, data: "GroupApplicationRequest", 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.
        auth: Authentication information.

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

    return await self._client.api.approve_all_pending(
        data=data, group_id=self._fuzzy_getattr("group_id"), auth=auth
    )

approve_pending_for_list(data, 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
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/models/mixins/clan.py 
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
async def approve_pending_for_list(
    self, data: "GroupApplicationListRequest", 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.
        auth: Authentication information.

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

    return await self._client.api.approve_pending_for_list(
        data=data, group_id=self._fuzzy_getattr("group_id"), auth=auth
    )

deny_all_pending(data, 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
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/models/mixins/clan.py 
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
async def deny_all_pending(self, data: "GroupApplicationRequest", 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.
        auth: Authentication information.

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

    return await self._client.api.deny_all_pending(data=data, group_id=self._fuzzy_getattr("group_id"), auth=auth)

deny_pending_for_list(data, 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
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/models/mixins/clan.py 
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
async def deny_pending_for_list(
    self, data: "GroupApplicationListRequest", 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.
        auth: Authentication information.

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

    return await self._client.api.deny_pending_for_list(
        data=data, group_id=self._fuzzy_getattr("group_id"), auth=auth
    )

edit_clan_banner(data, 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
auth AuthData

Authentication information.

 required

Returns:

Type Description
int

The model which is returned by bungie. General endpoint information.
Source code in src/bungio/models/mixins/clan.py 
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
async def edit_clan_banner(self, data: "ClanBanner", 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.
        auth: Authentication information.

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

    return await self._client.api.edit_clan_banner(data=data, group_id=self._fuzzy_getattr("group_id"), auth=auth)

edit_founder_options(data, 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
auth AuthData

Authentication information.

 required

Returns:

Type Description
int

The model which is returned by bungie. General endpoint information.
Source code in src/bungio/models/mixins/clan.py 
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
async def edit_founder_options(self, data: "GroupOptionsEditAction", 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.
        auth: Authentication information.

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

    return await self._client.api.edit_founder_options(
        data=data, group_id=self._fuzzy_getattr("group_id"), auth=auth
    )

edit_group(data, 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
auth AuthData

Authentication information.

 required

Returns:

Type Description
int

The model which is returned by bungie. General endpoint information.
Source code in src/bungio/models/mixins/clan.py 
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
async def edit_group(self, data: "GroupEditAction", 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.
        auth: Authentication information.

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

    return await self._client.api.edit_group(data=data, group_id=self._fuzzy_getattr("group_id"), auth=auth)

edit_optional_conversation(data, conversation_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
auth AuthData

Authentication information.

 required

Returns:

Type Description
int

The model which is returned by bungie. General endpoint information.
Source code in src/bungio/models/mixins/clan.py 
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
async def edit_optional_conversation(
    self, data: "GroupOptionalConversationEditRequest", conversation_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.
        auth: Authentication information.

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

    return await self._client.api.edit_optional_conversation(
        data=data, conversation_id=conversation_id, group_id=self._fuzzy_getattr("group_id"), auth=auth
    )

get_active_private_clan_fireteam_count(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
auth AuthData

Authentication information.

 required

Returns:

Type Description
int

The model which is returned by bungie. General endpoint information.
Source code in src/bungio/models/mixins/clan.py 
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
async def get_active_private_clan_fireteam_count(self, 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:
        auth: Authentication information.

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

    return await self._client.api.get_active_private_clan_fireteam_count(
        group_id=self._fuzzy_getattr("group_id"), auth=auth
    )

get_admins_and_founder_of_group(currentpage, 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
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/models/mixins/clan.py 
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
async def get_admins_and_founder_of_group(
    self, currentpage: 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.
        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)
    """

    return await self._client.api.get_admins_and_founder_of_group(
        currentpage=currentpage, group_id=self._fuzzy_getattr("group_id"), auth=auth
    )

get_available_clan_fireteams(activity_type, date_range, page, platform, public_only, slot_filter, auth, exclude_immediate, lang_filter) 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
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 bool

If you wish the result to exclude immediate fireteams, set this to true. Immediate-only can be forced using the dateRange enum.

 required
lang_filter str

An optional language filter.

 required

Returns:

Type Description
SearchResultOfFireteamSummary

The model which is returned by bungie. General endpoint information.
Source code in src/bungio/models/mixins/clan.py 
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
async def get_available_clan_fireteams(
    self,
    activity_type: int,
    date_range: Union["FireteamDateRange", int],
    page: int,
    platform: Union["FireteamPlatform", int],
    public_only: Union["FireteamPublicSearchOption", int],
    slot_filter: Union["FireteamSlotSearch", int],
    auth: "AuthData",
    exclude_immediate: bool,
    lang_filter: str,
) -> "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.
        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)
    """

    return await self._client.api.get_available_clan_fireteams(
        activity_type=activity_type,
        date_range=date_range,
        group_id=self._fuzzy_getattr("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_banned_members_of_group(currentpage, 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
auth AuthData

Authentication information.

 required

Returns:

Type Description
SearchResultOfGroupBan

The model which is returned by bungie. General endpoint information.
Source code in src/bungio/models/mixins/clan.py 
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
async def get_banned_members_of_group(self, currentpage: 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.
        auth: Authentication information.

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

    return await self._client.api.get_banned_members_of_group(
        currentpage=currentpage, group_id=self._fuzzy_getattr("group_id"), auth=auth
    )

get_clan_aggregate_stats(modes, auth=None) async

Gets aggregated stats for a clan using the same categories as the clan leaderboards. PREVIEW: This endpoint is still in beta, and may experience rough edges. The schema is in final form, but there may be bugs that prevent desirable operation.

Parameters:

Name Type Description Default
modes str

List of game modes for which to get leaderboards. See the documentation for DestinyActivityModeType for valid values, and pass in string representation, comma delimited.

 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[DestinyClanAggregateStat]

The model which is returned by bungie. General endpoint information.
Source code in src/bungio/models/mixins/clan.py 
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
async def get_clan_aggregate_stats(
    self, modes: str, auth: Optional["AuthData"] = None
) -> list["DestinyClanAggregateStat"]:
    """
    Gets aggregated stats for a clan using the same categories as the clan leaderboards. PREVIEW: This endpoint is still in beta, and may experience rough edges. The schema is in final form, but there may be bugs that prevent desirable operation.

    Args:
        modes: List of game modes for which to get leaderboards. See the documentation for DestinyActivityModeType for valid values, and pass in string representation, comma delimited.
        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)
    """

    return await self._client.api.get_clan_aggregate_stats(
        group_id=self._fuzzy_getattr("group_id"), modes=modes, auth=auth
    )

get_clan_fireteam(fireteam_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
auth AuthData

Authentication information.

 required

Returns:

Type Description
FireteamResponse

The model which is returned by bungie. General endpoint information.
Source code in src/bungio/models/mixins/clan.py 
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
async def get_clan_fireteam(self, fireteam_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.
        auth: Authentication information.

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

    return await self._client.api.get_clan_fireteam(
        fireteam_id=fireteam_id, group_id=self._fuzzy_getattr("group_id"), auth=auth
    )

get_clan_leaderboards(maxtop, modes, statid, auth=None) async

Gets leaderboards with the signed in user's friends and the supplied destinyMembershipId as the focus. PREVIEW: This endpoint is still in beta, and may experience rough edges. The schema is in final form, but there may be bugs that prevent desirable operation.

Parameters:

Name Type Description Default
maxtop int

Maximum number of top players to return. Use a large number to get entire leaderboard.

 required
modes str

List of game modes for which to get leaderboards. See the documentation for DestinyActivityModeType for valid values, and pass in string representation, comma delimited.

 required
statid str

ID of stat to return rather than returning all Leaderboard stats.

 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
dict[str, dict[str, DestinyLeaderboard]]

The model which is returned by bungie. General endpoint information.
Source code in src/bungio/models/mixins/clan.py 
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
async def get_clan_leaderboards(
    self, maxtop: int, modes: str, statid: str, auth: Optional["AuthData"] = None
) -> dict[str, dict[str, "DestinyLeaderboard"]]:
    """
    Gets leaderboards with the signed in user's friends and the supplied destinyMembershipId as the focus. PREVIEW: This endpoint is still in beta, and may experience rough edges. The schema is in final form, but there may be bugs that prevent desirable operation.

    Args:
        maxtop: Maximum number of top players to return. Use a large number to get entire leaderboard.
        modes: List of game modes for which to get leaderboards. See the documentation for DestinyActivityModeType for valid values, and pass in string representation, comma delimited.
        statid: ID of stat to return rather than returning all Leaderboard stats.
        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)
    """

    return await self._client.api.get_clan_leaderboards(
        group_id=self._fuzzy_getattr("group_id"), maxtop=maxtop, modes=modes, statid=statid, auth=auth
    )

get_clan_weekly_reward_state(auth=None) async

Returns information on the weekly clan rewards and if the clan has earned them or not. Note that this will always report rewards as not redeemed.

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
DestinyMilestone

The model which is returned by bungie. General endpoint information.
Source code in src/bungio/models/mixins/clan.py 
401
402
403
404
405
406
407
408
409
410
411
412
async def get_clan_weekly_reward_state(self, auth: Optional["AuthData"] = None) -> "DestinyMilestone":
    """
    Returns information on the weekly clan rewards and if the clan has earned them or not. Note that this will always report rewards as not redeemed.

    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)
    """

    return await self._client.api.get_clan_weekly_reward_state(group_id=self._fuzzy_getattr("group_id"), auth=auth)

get_group(auth=None) async

Get information about a specific group of the given ID.

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
GroupResponse

The model which is returned by bungie. General endpoint information.
Source code in src/bungio/models/mixins/clan.py 
46
47
48
49
50
51
52
53
54
55
56
57
async def get_group(self, auth: Optional["AuthData"] = None) -> "GroupResponse":
    """
    Get information about a specific group of the given ID.

    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)
    """

    return await self._client.api.get_group(group_id=self._fuzzy_getattr("group_id"), auth=auth)

get_group_edit_history(currentpage, 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
auth AuthData

Authentication information.

 required

Returns:

Type Description
SearchResultOfGroupEditHistory

The model which is returned by bungie. General endpoint information.
Source code in src/bungio/models/mixins/clan.py 
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
async def get_group_edit_history(self, currentpage: 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.
        auth: Authentication information.

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

    return await self._client.api.get_group_edit_history(
        currentpage=currentpage, group_id=self._fuzzy_getattr("group_id"), auth=auth
    )

get_group_optional_conversations(auth=None) async

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

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[GroupOptionalConversation]

The model which is returned by bungie. General endpoint information.
Source code in src/bungio/models/mixins/clan.py 
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
async def get_group_optional_conversations(
    self, auth: Optional["AuthData"] = None
) -> list["GroupOptionalConversation"]:
    """
    Gets a list of available optional conversation channels and their settings.

    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)
    """

    return await self._client.api.get_group_optional_conversations(
        group_id=self._fuzzy_getattr("group_id"), auth=auth
    )

get_invited_individuals(currentpage, 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
auth AuthData

Authentication information.

 required

Returns:

Type Description
SearchResultOfGroupMemberApplication

The model which is returned by bungie. General endpoint information.
Source code in src/bungio/models/mixins/clan.py 
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
async def get_invited_individuals(
    self, currentpage: 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.
        auth: Authentication information.

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

    return await self._client.api.get_invited_individuals(
        currentpage=currentpage, group_id=self._fuzzy_getattr("group_id"), auth=auth
    )

get_members_of_group(currentpage, member_type, name_search, 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
member_type Union[RuntimeGroupMemberType, int]

Filter out other member types. Use None for all members.

 required
name_search str

The name fragment upon which a search should be executed for members with matching display or unique names.

 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/models/mixins/clan.py 
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
async def get_members_of_group(
    self,
    currentpage: int,
    member_type: Union["RuntimeGroupMemberType", int],
    name_search: str,
    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.
        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)
    """

    return await self._client.api.get_members_of_group(
        currentpage=currentpage,
        group_id=self._fuzzy_getattr("group_id"),
        member_type=member_type,
        name_search=name_search,
        auth=auth,
    )

get_my_clan_fireteams(include_closed, page, platform, auth, group_filter, lang_filter) 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
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 bool

If true, filter by clan. Otherwise, ignore the clan and show all of the user's fireteams.

 required
lang_filter str

An optional language filter.

 required

Returns:

Type Description
SearchResultOfFireteamResponse

The model which is returned by bungie. General endpoint information.
Source code in src/bungio/models/mixins/clan.py 
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
async def get_my_clan_fireteams(
    self,
    include_closed: bool,
    page: int,
    platform: Union["FireteamPlatform", int],
    auth: "AuthData",
    group_filter: bool,
    lang_filter: str,
) -> "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:
        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)
    """

    return await self._client.api.get_my_clan_fireteams(
        group_id=self._fuzzy_getattr("group_id"),
        include_closed=include_closed,
        page=page,
        platform=platform,
        auth=auth,
        group_filter=group_filter,
        lang_filter=lang_filter,
    )

get_pending_memberships(currentpage, 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
auth AuthData

Authentication information.

 required

Returns:

Type Description
SearchResultOfGroupMemberApplication

The model which is returned by bungie. General endpoint information.
Source code in src/bungio/models/mixins/clan.py 
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
async def get_pending_memberships(
    self, currentpage: 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.
        auth: Authentication information.

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

    return await self._client.api.get_pending_memberships(
        currentpage=currentpage, group_id=self._fuzzy_getattr("group_id"), auth=auth
    )

DestinyClanMixin

Bases: ClientMixin, FuzzyAttrFinder

Source code in src/bungio/models/mixins/clan.py 
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
@custom_define()
class DestinyClanMixin(ClientMixin, FuzzyAttrFinder):
    # DO NOT CHANGE ANY CODE BELOW. Automatically generated and overwritten

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

        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)
        """

        return await self._client.api.get_group(group_id=self._fuzzy_getattr("group_id"), auth=auth)

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

        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)
        """

        return await self._client.api.get_group_optional_conversations(
            group_id=self._fuzzy_getattr("group_id"), auth=auth
        )

    async def edit_group(self, data: "GroupEditAction", 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.
            auth: Authentication information.

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

        return await self._client.api.edit_group(data=data, group_id=self._fuzzy_getattr("group_id"), auth=auth)

    async def edit_clan_banner(self, data: "ClanBanner", 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.
            auth: Authentication information.

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

        return await self._client.api.edit_clan_banner(data=data, group_id=self._fuzzy_getattr("group_id"), auth=auth)

    async def edit_founder_options(self, data: "GroupOptionsEditAction", 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.
            auth: Authentication information.

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

        return await self._client.api.edit_founder_options(
            data=data, group_id=self._fuzzy_getattr("group_id"), auth=auth
        )

    async def add_optional_conversation(self, data: "GroupOptionalConversationAddRequest", 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.
            auth: Authentication information.

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

        return await self._client.api.add_optional_conversation(
            data=data, group_id=self._fuzzy_getattr("group_id"), auth=auth
        )

    async def edit_optional_conversation(
        self, data: "GroupOptionalConversationEditRequest", conversation_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.
            auth: Authentication information.

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

        return await self._client.api.edit_optional_conversation(
            data=data, conversation_id=conversation_id, group_id=self._fuzzy_getattr("group_id"), auth=auth
        )

    async def get_members_of_group(
        self,
        currentpage: int,
        member_type: Union["RuntimeGroupMemberType", int],
        name_search: str,
        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.
            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)
        """

        return await self._client.api.get_members_of_group(
            currentpage=currentpage,
            group_id=self._fuzzy_getattr("group_id"),
            member_type=member_type,
            name_search=name_search,
            auth=auth,
        )

    async def get_admins_and_founder_of_group(
        self, currentpage: 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.
            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)
        """

        return await self._client.api.get_admins_and_founder_of_group(
            currentpage=currentpage, group_id=self._fuzzy_getattr("group_id"), auth=auth
        )

    async def get_banned_members_of_group(self, currentpage: 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.
            auth: Authentication information.

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

        return await self._client.api.get_banned_members_of_group(
            currentpage=currentpage, group_id=self._fuzzy_getattr("group_id"), auth=auth
        )

    async def get_group_edit_history(self, currentpage: 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.
            auth: Authentication information.

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

        return await self._client.api.get_group_edit_history(
            currentpage=currentpage, group_id=self._fuzzy_getattr("group_id"), auth=auth
        )

    async def abdicate_foundership(
        self,
        founder_id_new: 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.
            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)
        """

        return await self._client.api.abdicate_foundership(
            founder_id_new=founder_id_new,
            group_id=self._fuzzy_getattr("group_id"),
            membership_type=membership_type,
            auth=auth,
        )

    async def get_pending_memberships(
        self, currentpage: 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.
            auth: Authentication information.

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

        return await self._client.api.get_pending_memberships(
            currentpage=currentpage, group_id=self._fuzzy_getattr("group_id"), auth=auth
        )

    async def get_invited_individuals(
        self, currentpage: 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.
            auth: Authentication information.

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

        return await self._client.api.get_invited_individuals(
            currentpage=currentpage, group_id=self._fuzzy_getattr("group_id"), auth=auth
        )

    async def approve_all_pending(
        self, data: "GroupApplicationRequest", 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.
            auth: Authentication information.

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

        return await self._client.api.approve_all_pending(
            data=data, group_id=self._fuzzy_getattr("group_id"), auth=auth
        )

    async def deny_all_pending(self, data: "GroupApplicationRequest", 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.
            auth: Authentication information.

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

        return await self._client.api.deny_all_pending(data=data, group_id=self._fuzzy_getattr("group_id"), auth=auth)

    async def approve_pending_for_list(
        self, data: "GroupApplicationListRequest", 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.
            auth: Authentication information.

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

        return await self._client.api.approve_pending_for_list(
            data=data, group_id=self._fuzzy_getattr("group_id"), auth=auth
        )

    async def deny_pending_for_list(
        self, data: "GroupApplicationListRequest", 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.
            auth: Authentication information.

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

        return await self._client.api.deny_pending_for_list(
            data=data, group_id=self._fuzzy_getattr("group_id"), auth=auth
        )

    async def get_clan_weekly_reward_state(self, auth: Optional["AuthData"] = None) -> "DestinyMilestone":
        """
        Returns information on the weekly clan rewards and if the clan has earned them or not. Note that this will always report rewards as not redeemed.

        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)
        """

        return await self._client.api.get_clan_weekly_reward_state(group_id=self._fuzzy_getattr("group_id"), auth=auth)

    async def get_clan_leaderboards(
        self, maxtop: int, modes: str, statid: str, auth: Optional["AuthData"] = None
    ) -> dict[str, dict[str, "DestinyLeaderboard"]]:
        """
        Gets leaderboards with the signed in user's friends and the supplied destinyMembershipId as the focus. PREVIEW: This endpoint is still in beta, and may experience rough edges. The schema is in final form, but there may be bugs that prevent desirable operation.

        Args:
            maxtop: Maximum number of top players to return. Use a large number to get entire leaderboard.
            modes: List of game modes for which to get leaderboards. See the documentation for DestinyActivityModeType for valid values, and pass in string representation, comma delimited.
            statid: ID of stat to return rather than returning all Leaderboard stats.
            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)
        """

        return await self._client.api.get_clan_leaderboards(
            group_id=self._fuzzy_getattr("group_id"), maxtop=maxtop, modes=modes, statid=statid, auth=auth
        )

    async def get_clan_aggregate_stats(
        self, modes: str, auth: Optional["AuthData"] = None
    ) -> list["DestinyClanAggregateStat"]:
        """
        Gets aggregated stats for a clan using the same categories as the clan leaderboards. PREVIEW: This endpoint is still in beta, and may experience rough edges. The schema is in final form, but there may be bugs that prevent desirable operation.

        Args:
            modes: List of game modes for which to get leaderboards. See the documentation for DestinyActivityModeType for valid values, and pass in string representation, comma delimited.
            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)
        """

        return await self._client.api.get_clan_aggregate_stats(
            group_id=self._fuzzy_getattr("group_id"), modes=modes, auth=auth
        )

    async def get_active_private_clan_fireteam_count(self, 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:
            auth: Authentication information.

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

        return await self._client.api.get_active_private_clan_fireteam_count(
            group_id=self._fuzzy_getattr("group_id"), auth=auth
        )

    async def get_available_clan_fireteams(
        self,
        activity_type: int,
        date_range: Union["FireteamDateRange", int],
        page: int,
        platform: Union["FireteamPlatform", int],
        public_only: Union["FireteamPublicSearchOption", int],
        slot_filter: Union["FireteamSlotSearch", int],
        auth: "AuthData",
        exclude_immediate: bool,
        lang_filter: str,
    ) -> "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.
            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)
        """

        return await self._client.api.get_available_clan_fireteams(
            activity_type=activity_type,
            date_range=date_range,
            group_id=self._fuzzy_getattr("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 get_my_clan_fireteams(
        self,
        include_closed: bool,
        page: int,
        platform: Union["FireteamPlatform", int],
        auth: "AuthData",
        group_filter: bool,
        lang_filter: str,
    ) -> "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:
            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)
        """

        return await self._client.api.get_my_clan_fireteams(
            group_id=self._fuzzy_getattr("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, auth: "AuthData") -> "FireteamResponse":
        """
        Gets a specific fireteam.

        Warning: Requires Authentication.
            Required oauth2 scopes: ReadGroups

        Args:
            fireteam_id: The unique id of the fireteam.
            auth: Authentication information.

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

        return await self._client.api.get_clan_fireteam(
            fireteam_id=fireteam_id, group_id=self._fuzzy_getattr("group_id"), auth=auth
        )

_fuzzy_getattr(name)

Returns the objs attribute that fully matches the name, or if that does not exist, the first attribute that includes the name

Parameters:

Name Type Description Default
name str

The name to match

 required

Raises:

Type Description
KeyError

If no match is found

Returns:

Type Description
Any

The attribute value
Source code in src/bungio/models/base.py 
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
def _fuzzy_getattr(self, name: str) -> Any:
    """
    Returns the objs attribute that fully matches the name, or if that does not exist, the first attribute that includes the name

    Args:
        name: The name to match

    Raises:
        KeyError: If no match is found

    Returns:
        The attribute value
    """

    try:
        found_attr = getattr(self, name)
        return found_attr
    except AttributeError:
        for attr_name in self.__dir__():
            if name in attr_name:
                return getattr(self, attr_name)
        raise KeyError(f"`{name}` not found in `{self.__dir__()}`")

abdicate_foundership(founder_id_new, 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
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/models/mixins/clan.py 
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
async def abdicate_foundership(
    self,
    founder_id_new: 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.
        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)
    """

    return await self._client.api.abdicate_foundership(
        founder_id_new=founder_id_new,
        group_id=self._fuzzy_getattr("group_id"),
        membership_type=membership_type,
        auth=auth,
    )

add_optional_conversation(data, 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
auth AuthData

Authentication information.

 required

Returns:

Type Description
int

The model which is returned by bungie. General endpoint information.
Source code in src/bungio/models/mixins/clan.py 
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
async def add_optional_conversation(self, data: "GroupOptionalConversationAddRequest", 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.
        auth: Authentication information.

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

    return await self._client.api.add_optional_conversation(
        data=data, group_id=self._fuzzy_getattr("group_id"), auth=auth
    )

approve_all_pending(data, 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
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/models/mixins/clan.py 
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
async def approve_all_pending(
    self, data: "GroupApplicationRequest", 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.
        auth: Authentication information.

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

    return await self._client.api.approve_all_pending(
        data=data, group_id=self._fuzzy_getattr("group_id"), auth=auth
    )

approve_pending_for_list(data, 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
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/models/mixins/clan.py 
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
async def approve_pending_for_list(
    self, data: "GroupApplicationListRequest", 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.
        auth: Authentication information.

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

    return await self._client.api.approve_pending_for_list(
        data=data, group_id=self._fuzzy_getattr("group_id"), auth=auth
    )

deny_all_pending(data, 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
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/models/mixins/clan.py 
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
async def deny_all_pending(self, data: "GroupApplicationRequest", 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.
        auth: Authentication information.

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

    return await self._client.api.deny_all_pending(data=data, group_id=self._fuzzy_getattr("group_id"), auth=auth)

deny_pending_for_list(data, 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
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/models/mixins/clan.py 
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
async def deny_pending_for_list(
    self, data: "GroupApplicationListRequest", 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.
        auth: Authentication information.

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

    return await self._client.api.deny_pending_for_list(
        data=data, group_id=self._fuzzy_getattr("group_id"), auth=auth
    )

edit_clan_banner(data, 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
auth AuthData

Authentication information.

 required

Returns:

Type Description
int

The model which is returned by bungie. General endpoint information.
Source code in src/bungio/models/mixins/clan.py 
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
async def edit_clan_banner(self, data: "ClanBanner", 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.
        auth: Authentication information.

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

    return await self._client.api.edit_clan_banner(data=data, group_id=self._fuzzy_getattr("group_id"), auth=auth)

edit_founder_options(data, 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
auth AuthData

Authentication information.

 required

Returns:

Type Description
int

The model which is returned by bungie. General endpoint information.
Source code in src/bungio/models/mixins/clan.py 
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
async def edit_founder_options(self, data: "GroupOptionsEditAction", 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.
        auth: Authentication information.

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

    return await self._client.api.edit_founder_options(
        data=data, group_id=self._fuzzy_getattr("group_id"), auth=auth
    )

edit_group(data, 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
auth AuthData

Authentication information.

 required

Returns:

Type Description
int

The model which is returned by bungie. General endpoint information.
Source code in src/bungio/models/mixins/clan.py 
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
async def edit_group(self, data: "GroupEditAction", 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.
        auth: Authentication information.

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

    return await self._client.api.edit_group(data=data, group_id=self._fuzzy_getattr("group_id"), auth=auth)

edit_optional_conversation(data, conversation_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
auth AuthData

Authentication information.

 required

Returns:

Type Description
int

The model which is returned by bungie. General endpoint information.
Source code in src/bungio/models/mixins/clan.py 
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
async def edit_optional_conversation(
    self, data: "GroupOptionalConversationEditRequest", conversation_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.
        auth: Authentication information.

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

    return await self._client.api.edit_optional_conversation(
        data=data, conversation_id=conversation_id, group_id=self._fuzzy_getattr("group_id"), auth=auth
    )

get_active_private_clan_fireteam_count(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
auth AuthData

Authentication information.

 required

Returns:

Type Description
int

The model which is returned by bungie. General endpoint information.
Source code in src/bungio/models/mixins/clan.py 
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
async def get_active_private_clan_fireteam_count(self, 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:
        auth: Authentication information.

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

    return await self._client.api.get_active_private_clan_fireteam_count(
        group_id=self._fuzzy_getattr("group_id"), auth=auth
    )

get_admins_and_founder_of_group(currentpage, 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
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/models/mixins/clan.py 
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
async def get_admins_and_founder_of_group(
    self, currentpage: 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.
        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)
    """

    return await self._client.api.get_admins_and_founder_of_group(
        currentpage=currentpage, group_id=self._fuzzy_getattr("group_id"), auth=auth
    )

get_available_clan_fireteams(activity_type, date_range, page, platform, public_only, slot_filter, auth, exclude_immediate, lang_filter) 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
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 bool

If you wish the result to exclude immediate fireteams, set this to true. Immediate-only can be forced using the dateRange enum.

 required
lang_filter str

An optional language filter.

 required

Returns:

Type Description
SearchResultOfFireteamSummary

The model which is returned by bungie. General endpoint information.
Source code in src/bungio/models/mixins/clan.py 
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
async def get_available_clan_fireteams(
    self,
    activity_type: int,
    date_range: Union["FireteamDateRange", int],
    page: int,
    platform: Union["FireteamPlatform", int],
    public_only: Union["FireteamPublicSearchOption", int],
    slot_filter: Union["FireteamSlotSearch", int],
    auth: "AuthData",
    exclude_immediate: bool,
    lang_filter: str,
) -> "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.
        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)
    """

    return await self._client.api.get_available_clan_fireteams(
        activity_type=activity_type,
        date_range=date_range,
        group_id=self._fuzzy_getattr("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_banned_members_of_group(currentpage, 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
auth AuthData

Authentication information.

 required

Returns:

Type Description
SearchResultOfGroupBan

The model which is returned by bungie. General endpoint information.
Source code in src/bungio/models/mixins/clan.py 
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
async def get_banned_members_of_group(self, currentpage: 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.
        auth: Authentication information.

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

    return await self._client.api.get_banned_members_of_group(
        currentpage=currentpage, group_id=self._fuzzy_getattr("group_id"), auth=auth
    )

get_clan_aggregate_stats(modes, auth=None) async

Gets aggregated stats for a clan using the same categories as the clan leaderboards. PREVIEW: This endpoint is still in beta, and may experience rough edges. The schema is in final form, but there may be bugs that prevent desirable operation.

Parameters:

Name Type Description Default
modes str

List of game modes for which to get leaderboards. See the documentation for DestinyActivityModeType for valid values, and pass in string representation, comma delimited.

 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[DestinyClanAggregateStat]

The model which is returned by bungie. General endpoint information.
Source code in src/bungio/models/mixins/clan.py 
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
async def get_clan_aggregate_stats(
    self, modes: str, auth: Optional["AuthData"] = None
) -> list["DestinyClanAggregateStat"]:
    """
    Gets aggregated stats for a clan using the same categories as the clan leaderboards. PREVIEW: This endpoint is still in beta, and may experience rough edges. The schema is in final form, but there may be bugs that prevent desirable operation.

    Args:
        modes: List of game modes for which to get leaderboards. See the documentation for DestinyActivityModeType for valid values, and pass in string representation, comma delimited.
        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)
    """

    return await self._client.api.get_clan_aggregate_stats(
        group_id=self._fuzzy_getattr("group_id"), modes=modes, auth=auth
    )

get_clan_fireteam(fireteam_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
auth AuthData

Authentication information.

 required

Returns:

Type Description
FireteamResponse

The model which is returned by bungie. General endpoint information.
Source code in src/bungio/models/mixins/clan.py 
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
async def get_clan_fireteam(self, fireteam_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.
        auth: Authentication information.

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

    return await self._client.api.get_clan_fireteam(
        fireteam_id=fireteam_id, group_id=self._fuzzy_getattr("group_id"), auth=auth
    )

get_clan_leaderboards(maxtop, modes, statid, auth=None) async

Gets leaderboards with the signed in user's friends and the supplied destinyMembershipId as the focus. PREVIEW: This endpoint is still in beta, and may experience rough edges. The schema is in final form, but there may be bugs that prevent desirable operation.

Parameters:

Name Type Description Default
maxtop int

Maximum number of top players to return. Use a large number to get entire leaderboard.

 required
modes str

List of game modes for which to get leaderboards. See the documentation for DestinyActivityModeType for valid values, and pass in string representation, comma delimited.

 required
statid str

ID of stat to return rather than returning all Leaderboard stats.

 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
dict[str, dict[str, DestinyLeaderboard]]

The model which is returned by bungie. General endpoint information.
Source code in src/bungio/models/mixins/clan.py 
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
async def get_clan_leaderboards(
    self, maxtop: int, modes: str, statid: str, auth: Optional["AuthData"] = None
) -> dict[str, dict[str, "DestinyLeaderboard"]]:
    """
    Gets leaderboards with the signed in user's friends and the supplied destinyMembershipId as the focus. PREVIEW: This endpoint is still in beta, and may experience rough edges. The schema is in final form, but there may be bugs that prevent desirable operation.

    Args:
        maxtop: Maximum number of top players to return. Use a large number to get entire leaderboard.
        modes: List of game modes for which to get leaderboards. See the documentation for DestinyActivityModeType for valid values, and pass in string representation, comma delimited.
        statid: ID of stat to return rather than returning all Leaderboard stats.
        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)
    """

    return await self._client.api.get_clan_leaderboards(
        group_id=self._fuzzy_getattr("group_id"), maxtop=maxtop, modes=modes, statid=statid, auth=auth
    )

get_clan_weekly_reward_state(auth=None) async

Returns information on the weekly clan rewards and if the clan has earned them or not. Note that this will always report rewards as not redeemed.

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
DestinyMilestone

The model which is returned by bungie. General endpoint information.
Source code in src/bungio/models/mixins/clan.py 
401
402
403
404
405
406
407
408
409
410
411
412
async def get_clan_weekly_reward_state(self, auth: Optional["AuthData"] = None) -> "DestinyMilestone":
    """
    Returns information on the weekly clan rewards and if the clan has earned them or not. Note that this will always report rewards as not redeemed.

    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)
    """

    return await self._client.api.get_clan_weekly_reward_state(group_id=self._fuzzy_getattr("group_id"), auth=auth)

get_group(auth=None) async

Get information about a specific group of the given ID.

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
GroupResponse

The model which is returned by bungie. General endpoint information.
Source code in src/bungio/models/mixins/clan.py 
46
47
48
49
50
51
52
53
54
55
56
57
async def get_group(self, auth: Optional["AuthData"] = None) -> "GroupResponse":
    """
    Get information about a specific group of the given ID.

    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)
    """

    return await self._client.api.get_group(group_id=self._fuzzy_getattr("group_id"), auth=auth)

get_group_edit_history(currentpage, 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
auth AuthData

Authentication information.

 required

Returns:

Type Description
SearchResultOfGroupEditHistory

The model which is returned by bungie. General endpoint information.
Source code in src/bungio/models/mixins/clan.py 
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
async def get_group_edit_history(self, currentpage: 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.
        auth: Authentication information.

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

    return await self._client.api.get_group_edit_history(
        currentpage=currentpage, group_id=self._fuzzy_getattr("group_id"), auth=auth
    )

get_group_optional_conversations(auth=None) async

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

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[GroupOptionalConversation]

The model which is returned by bungie. General endpoint information.
Source code in src/bungio/models/mixins/clan.py 
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
async def get_group_optional_conversations(
    self, auth: Optional["AuthData"] = None
) -> list["GroupOptionalConversation"]:
    """
    Gets a list of available optional conversation channels and their settings.

    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)
    """

    return await self._client.api.get_group_optional_conversations(
        group_id=self._fuzzy_getattr("group_id"), auth=auth
    )

get_invited_individuals(currentpage, 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
auth AuthData

Authentication information.

 required

Returns:

Type Description
SearchResultOfGroupMemberApplication

The model which is returned by bungie. General endpoint information.
Source code in src/bungio/models/mixins/clan.py 
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
async def get_invited_individuals(
    self, currentpage: 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.
        auth: Authentication information.

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

    return await self._client.api.get_invited_individuals(
        currentpage=currentpage, group_id=self._fuzzy_getattr("group_id"), auth=auth
    )

get_members_of_group(currentpage, member_type, name_search, 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
member_type Union[RuntimeGroupMemberType, int]

Filter out other member types. Use None for all members.

 required
name_search str

The name fragment upon which a search should be executed for members with matching display or unique names.

 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/models/mixins/clan.py 
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
async def get_members_of_group(
    self,
    currentpage: int,
    member_type: Union["RuntimeGroupMemberType", int],
    name_search: str,
    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.
        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)
    """

    return await self._client.api.get_members_of_group(
        currentpage=currentpage,
        group_id=self._fuzzy_getattr("group_id"),
        member_type=member_type,
        name_search=name_search,
        auth=auth,
    )

get_my_clan_fireteams(include_closed, page, platform, auth, group_filter, lang_filter) 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
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 bool

If true, filter by clan. Otherwise, ignore the clan and show all of the user's fireteams.

 required
lang_filter str

An optional language filter.

 required

Returns:

Type Description
SearchResultOfFireteamResponse

The model which is returned by bungie. General endpoint information.
Source code in src/bungio/models/mixins/clan.py 
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
async def get_my_clan_fireteams(
    self,
    include_closed: bool,
    page: int,
    platform: Union["FireteamPlatform", int],
    auth: "AuthData",
    group_filter: bool,
    lang_filter: str,
) -> "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:
        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)
    """

    return await self._client.api.get_my_clan_fireteams(
        group_id=self._fuzzy_getattr("group_id"),
        include_closed=include_closed,
        page=page,
        platform=platform,
        auth=auth,
        group_filter=group_filter,
        lang_filter=lang_filter,
    )

get_pending_memberships(currentpage, 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
auth AuthData

Authentication information.

 required

Returns:

Type Description
SearchResultOfGroupMemberApplication

The model which is returned by bungie. General endpoint information.
Source code in src/bungio/models/mixins/clan.py 
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
async def get_pending_memberships(
    self, currentpage: 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.
        auth: Authentication information.

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

    return await self._client.api.get_pending_memberships(
        currentpage=currentpage, group_id=self._fuzzy_getattr("group_id"), auth=auth
    )