Skip to content

Tokens Routes

TokensRouteInterface

Bases: ClientMixin

Source code in src/bungio/api/bungie/tokens.py 
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 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
@custom_define()
class TokensRouteInterface(ClientMixin):
    async def force_drops_repair(self, auth: AuthData) -> bool:
        """
        Twitch Drops self-repair function - scans twitch for drops not marked as fulfilled and resyncs them.

        Warning: Requires Authentication.
            Required oauth2 scopes: PartnerOfferGrant

        Args:
            auth: Authentication information.

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

        response = await self._client.http.force_drops_repair(auth=auth)
        return response["Response"]

    async def claim_partner_offer(self, data: PartnerOfferClaimRequest, auth: AuthData) -> bool:
        """
        Claim a partner offer as the authenticated user.

        Warning: Requires Authentication.
            Required oauth2 scopes: PartnerOfferGrant

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

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

    async def apply_missing_partner_offers_without_claim(
        self, partner_application_id: int, target_bnet_membership_id: int, auth: AuthData
    ) -> bool:
        """
        Apply a partner offer to the targeted user. This endpoint does not claim a new offer, but any already claimed offers will be applied to the game if not already.

        Warning: Requires Authentication.
            Required oauth2 scopes: PartnerOfferGrant

        Args:
            partner_application_id: The partner application identifier.
            target_bnet_membership_id: The bungie.net user to apply missing offers to. If not self, elevated permissions are required.
            auth: Authentication information.

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

        response = await self._client.http.apply_missing_partner_offers_without_claim(
            partner_application_id=partner_application_id,
            target_bnet_membership_id=target_bnet_membership_id,
            auth=auth,
        )
        return response["Response"]

    async def get_partner_offer_sku_history(
        self, partner_application_id: int, target_bnet_membership_id: int, auth: AuthData
    ) -> list[PartnerOfferSkuHistoryResponse]:
        """
        Returns the partner sku and offer history of the targeted user. Elevated permissions are required to see users that are not yourself.

        Warning: Requires Authentication.
            Required oauth2 scopes: PartnerOfferGrant

        Args:
            partner_application_id: The partner application identifier.
            target_bnet_membership_id: The bungie.net user to apply missing offers to. If not self, elevated permissions are required.
            auth: Authentication information.

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

        response = await self._client.http.get_partner_offer_sku_history(
            partner_application_id=partner_application_id,
            target_bnet_membership_id=target_bnet_membership_id,
            auth=auth,
        )
        return [
            await PartnerOfferSkuHistoryResponse.from_dict(
                data=value,
                client=self._client,
                partner_application_id=partner_application_id,
                target_bnet_membership_id=target_bnet_membership_id,
                auth=auth,
            )
            for value in response["Response"]
        ]

    async def get_partner_reward_history(
        self, partner_application_id: int, target_bnet_membership_id: int, auth: AuthData
    ) -> PartnerRewardHistoryResponse:
        """
        Returns the partner rewards history of the targeted user, both partner offers and Twitch drops.

        Warning: Requires Authentication.
            Required oauth2 scopes: PartnerOfferGrant

        Args:
            partner_application_id: The partner application identifier.
            target_bnet_membership_id: The bungie.net user to return reward history for.
            auth: Authentication information.

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

        response = await self._client.http.get_partner_reward_history(
            partner_application_id=partner_application_id,
            target_bnet_membership_id=target_bnet_membership_id,
            auth=auth,
        )
        return await PartnerRewardHistoryResponse.from_dict(
            data=response,
            client=self._client,
            partner_application_id=partner_application_id,
            target_bnet_membership_id=target_bnet_membership_id,
            auth=auth,
        )

    async def get_bungie_rewards_for_user(self, membership_id: int, auth: AuthData) -> dict[str, BungieRewardDisplay]:
        """
        Returns the bungie rewards for the targeted user.

        Warning: Requires Authentication.
            Required oauth2 scopes: ReadAndApplyTokens

        Args:
            membership_id: bungie.net user membershipId for requested user rewards. If not self, elevated permissions are required.
            auth: Authentication information.

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

        response = await self._client.http.get_bungie_rewards_for_user(membership_id=membership_id, auth=auth)
        return {
            key: await BungieRewardDisplay.from_dict(
                data=value, client=self._client, membership_id=membership_id, auth=auth
            )
            async for key, value in AllowAsyncIteration(response["Response"].items())
        }

    async def get_bungie_rewards_for_platform_user(
        self, membership_id: int, membership_type: Union[BungieMembershipType, int], auth: AuthData
    ) -> dict[str, BungieRewardDisplay]:
        """
        Returns the bungie rewards for the targeted user when a platform membership Id and Type are used.

        Warning: Requires Authentication.
            Required oauth2 scopes: ReadAndApplyTokens

        Args:
            membership_id: users platform membershipId for requested user rewards. If not self, elevated permissions are required.
            membership_type: The target Destiny 2 membership type.
            auth: Authentication information.

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

        response = await self._client.http.get_bungie_rewards_for_platform_user(
            membership_id=membership_id, membership_type=getattr(membership_type, "value", membership_type), auth=auth
        )
        return {
            key: await BungieRewardDisplay.from_dict(
                data=value, client=self._client, membership_id=membership_id, membership_type=membership_type, auth=auth
            )
            async for key, value in AllowAsyncIteration(response["Response"].items())
        }

    async def get_bungie_rewards_list(self, auth: Optional[AuthData] = None) -> dict[str, BungieRewardDisplay]:
        """
        Returns a list of the current bungie rewards

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

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

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

apply_missing_partner_offers_without_claim(partner_application_id, target_bnet_membership_id, auth) async

Apply a partner offer to the targeted user. This endpoint does not claim a new offer, but any already claimed offers will be applied to the game if not already.

Requires Authentication.

Required oauth2 scopes: PartnerOfferGrant

Parameters:

Name Type Description Default
partner_application_id int

The partner application identifier.

 required
target_bnet_membership_id int

The bungie.net user to apply missing offers to. If not self, elevated permissions are required.

 required
auth AuthData

Authentication information.

 required

Returns:

Type Description
bool

The model which is returned by bungie. General endpoint information.
Source code in src/bungio/api/bungie/tokens.py 
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
async def apply_missing_partner_offers_without_claim(
    self, partner_application_id: int, target_bnet_membership_id: int, auth: AuthData
) -> bool:
    """
    Apply a partner offer to the targeted user. This endpoint does not claim a new offer, but any already claimed offers will be applied to the game if not already.

    Warning: Requires Authentication.
        Required oauth2 scopes: PartnerOfferGrant

    Args:
        partner_application_id: The partner application identifier.
        target_bnet_membership_id: The bungie.net user to apply missing offers to. If not self, elevated permissions are required.
        auth: Authentication information.

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

    response = await self._client.http.apply_missing_partner_offers_without_claim(
        partner_application_id=partner_application_id,
        target_bnet_membership_id=target_bnet_membership_id,
        auth=auth,
    )
    return response["Response"]

claim_partner_offer(data, auth) async

Claim a partner offer as the authenticated user.

Requires Authentication.

Required oauth2 scopes: PartnerOfferGrant

Parameters:

Name Type Description Default
data PartnerOfferClaimRequest

The required data for this request.

 required
auth AuthData

Authentication information.

 required

Returns:

Type Description
bool

The model which is returned by bungie. General endpoint information.
Source code in src/bungio/api/bungie/tokens.py 
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
async def claim_partner_offer(self, data: PartnerOfferClaimRequest, auth: AuthData) -> bool:
    """
    Claim a partner offer as the authenticated user.

    Warning: Requires Authentication.
        Required oauth2 scopes: PartnerOfferGrant

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

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

force_drops_repair(auth) async

Twitch Drops self-repair function - scans twitch for drops not marked as fulfilled and resyncs them.

Requires Authentication.

Required oauth2 scopes: PartnerOfferGrant

Parameters:

Name Type Description Default
auth AuthData

Authentication information.

 required

Returns:

Type Description
bool

The model which is returned by bungie. General endpoint information.
Source code in src/bungio/api/bungie/tokens.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
async def force_drops_repair(self, auth: AuthData) -> bool:
    """
    Twitch Drops self-repair function - scans twitch for drops not marked as fulfilled and resyncs them.

    Warning: Requires Authentication.
        Required oauth2 scopes: PartnerOfferGrant

    Args:
        auth: Authentication information.

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

    response = await self._client.http.force_drops_repair(auth=auth)
    return response["Response"]

get_bungie_rewards_for_platform_user(membership_id, membership_type, auth) async

Returns the bungie rewards for the targeted user when a platform membership Id and Type are used.

Requires Authentication.

Required oauth2 scopes: ReadAndApplyTokens

Parameters:

Name Type Description Default
membership_id int

users platform membershipId for requested user rewards. If not self, elevated permissions are required.

 required
membership_type Union[BungieMembershipType, int]

The target Destiny 2 membership type.

 required
auth AuthData

Authentication information.

 required

Returns:

Type Description
dict[str, BungieRewardDisplay]

The model which is returned by bungie. General endpoint information.
Source code in src/bungio/api/bungie/tokens.py 
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
async def get_bungie_rewards_for_platform_user(
    self, membership_id: int, membership_type: Union[BungieMembershipType, int], auth: AuthData
) -> dict[str, BungieRewardDisplay]:
    """
    Returns the bungie rewards for the targeted user when a platform membership Id and Type are used.

    Warning: Requires Authentication.
        Required oauth2 scopes: ReadAndApplyTokens

    Args:
        membership_id: users platform membershipId for requested user rewards. If not self, elevated permissions are required.
        membership_type: The target Destiny 2 membership type.
        auth: Authentication information.

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

    response = await self._client.http.get_bungie_rewards_for_platform_user(
        membership_id=membership_id, membership_type=getattr(membership_type, "value", membership_type), auth=auth
    )
    return {
        key: await BungieRewardDisplay.from_dict(
            data=value, client=self._client, membership_id=membership_id, membership_type=membership_type, auth=auth
        )
        async for key, value in AllowAsyncIteration(response["Response"].items())
    }

get_bungie_rewards_for_user(membership_id, auth) async

Returns the bungie rewards for the targeted user.

Requires Authentication.

Required oauth2 scopes: ReadAndApplyTokens

Parameters:

Name Type Description Default
membership_id int

bungie.net user membershipId for requested user rewards. If not self, elevated permissions are required.

 required
auth AuthData

Authentication information.

 required

Returns:

Type Description
dict[str, BungieRewardDisplay]

The model which is returned by bungie. General endpoint information.
Source code in src/bungio/api/bungie/tokens.py 
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
async def get_bungie_rewards_for_user(self, membership_id: int, auth: AuthData) -> dict[str, BungieRewardDisplay]:
    """
    Returns the bungie rewards for the targeted user.

    Warning: Requires Authentication.
        Required oauth2 scopes: ReadAndApplyTokens

    Args:
        membership_id: bungie.net user membershipId for requested user rewards. If not self, elevated permissions are required.
        auth: Authentication information.

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

    response = await self._client.http.get_bungie_rewards_for_user(membership_id=membership_id, auth=auth)
    return {
        key: await BungieRewardDisplay.from_dict(
            data=value, client=self._client, membership_id=membership_id, auth=auth
        )
        async for key, value in AllowAsyncIteration(response["Response"].items())
    }

get_bungie_rewards_list(auth=None) async

Returns a list of the current bungie rewards

Parameters:

Name Type Description Default
auth Optional[AuthData]

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

 None

Returns:

Type Description
dict[str, BungieRewardDisplay]

The model which is returned by bungie. General endpoint information.
Source code in src/bungio/api/bungie/tokens.py 
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
async def get_bungie_rewards_list(self, auth: Optional[AuthData] = None) -> dict[str, BungieRewardDisplay]:
    """
    Returns a list of the current bungie rewards

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

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

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

get_partner_offer_sku_history(partner_application_id, target_bnet_membership_id, auth) async

Returns the partner sku and offer history of the targeted user. Elevated permissions are required to see users that are not yourself.

Requires Authentication.

Required oauth2 scopes: PartnerOfferGrant

Parameters:

Name Type Description Default
partner_application_id int

The partner application identifier.

 required
target_bnet_membership_id int

The bungie.net user to apply missing offers to. If not self, elevated permissions are required.

 required
auth AuthData

Authentication information.

 required

Returns:

Type Description
list[PartnerOfferSkuHistoryResponse]

The model which is returned by bungie. General endpoint information.
Source code in src/bungio/api/bungie/tokens.py 
 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
async def get_partner_offer_sku_history(
    self, partner_application_id: int, target_bnet_membership_id: int, auth: AuthData
) -> list[PartnerOfferSkuHistoryResponse]:
    """
    Returns the partner sku and offer history of the targeted user. Elevated permissions are required to see users that are not yourself.

    Warning: Requires Authentication.
        Required oauth2 scopes: PartnerOfferGrant

    Args:
        partner_application_id: The partner application identifier.
        target_bnet_membership_id: The bungie.net user to apply missing offers to. If not self, elevated permissions are required.
        auth: Authentication information.

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

    response = await self._client.http.get_partner_offer_sku_history(
        partner_application_id=partner_application_id,
        target_bnet_membership_id=target_bnet_membership_id,
        auth=auth,
    )
    return [
        await PartnerOfferSkuHistoryResponse.from_dict(
            data=value,
            client=self._client,
            partner_application_id=partner_application_id,
            target_bnet_membership_id=target_bnet_membership_id,
            auth=auth,
        )
        for value in response["Response"]
    ]

get_partner_reward_history(partner_application_id, target_bnet_membership_id, auth) async

Returns the partner rewards history of the targeted user, both partner offers and Twitch drops.

Requires Authentication.

Required oauth2 scopes: PartnerOfferGrant

Parameters:

Name Type Description Default
partner_application_id int

The partner application identifier.

 required
target_bnet_membership_id int

The bungie.net user to return reward history for.

 required
auth AuthData

Authentication information.

 required

Returns:

Type Description
PartnerRewardHistoryResponse

The model which is returned by bungie. General endpoint information.
Source code in src/bungio/api/bungie/tokens.py 
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
async def get_partner_reward_history(
    self, partner_application_id: int, target_bnet_membership_id: int, auth: AuthData
) -> PartnerRewardHistoryResponse:
    """
    Returns the partner rewards history of the targeted user, both partner offers and Twitch drops.

    Warning: Requires Authentication.
        Required oauth2 scopes: PartnerOfferGrant

    Args:
        partner_application_id: The partner application identifier.
        target_bnet_membership_id: The bungie.net user to return reward history for.
        auth: Authentication information.

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

    response = await self._client.http.get_partner_reward_history(
        partner_application_id=partner_application_id,
        target_bnet_membership_id=target_bnet_membership_id,
        auth=auth,
    )
    return await PartnerRewardHistoryResponse.from_dict(
        data=response,
        client=self._client,
        partner_application_id=partner_application_id,
        target_bnet_membership_id=target_bnet_membership_id,
        auth=auth,
    )