bungieapi.generated.components.schemas.user package

Submodules

bungieapi.generated.components.schemas.user.models module

class bungieapi.generated.components.schemas.user.models.GetCredentialTypesForAccountResponse(credential_as_string: Optional[str] = None, credential_display_name: Optional[str] = None, credential_type: Optional[ForwardRef('BungieCredentialType')] = None, is_public: Optional[bool] = None)[source]

Bases: object

credential_as_string: Optional[str] = None
credential_display_name: Optional[str] = None
credential_type: Optional[bungieapi.generated.components.schemas.BungieCredentialType] = None
is_public: Optional[bool] = None
to_json() → Mapping[str, Any][source]

Module contents

class bungieapi.generated.components.schemas.user.CrossSaveUserMembership(applicable_membership_types: Optional[Sequence[bungieapi.generated.components.schemas.BungieMembershipType]] = None, bungie_global_display_name: Optional[str] = None, bungie_global_display_name_code: Optional[int] = None, cross_save_override: Optional[bungieapi.generated.components.schemas.BungieMembershipType] = None, display_name: Optional[str] = None, is_public: Optional[bool] = None, membership_id: Optional[int] = None, membership_type: Optional[bungieapi.generated.components.schemas.BungieMembershipType] = None)[source]

Bases: object

Very basic info about a user as returned by the Account server, but including CrossSave information.

Do NOT use as a request contract.

applicable_membership_types: Optional[Sequence[bungieapi.generated.components.schemas.BungieMembershipType]] = None
bungie_global_display_name: Optional[str] = None
bungie_global_display_name_code: Optional[int] = None
cross_save_override: Optional[bungieapi.generated.components.schemas.BungieMembershipType] = None
display_name: Optional[str] = None
is_public: Optional[bool] = None
membership_id: Optional[int] = None
membership_type: Optional[bungieapi.generated.components.schemas.BungieMembershipType] = None
to_json() → Mapping[str, Any][source]
class bungieapi.generated.components.schemas.user.EMailSettingLocalization(description: Optional[str] = None, title: Optional[str] = None)[source]

Bases: object

Localized text relevant to a given EMail setting in a given localization.

description: Optional[str] = None
title: Optional[str] = None
to_json() → Mapping[str, Any][source]
class bungieapi.generated.components.schemas.user.EMailSettingSubscriptionLocalization(description: Optional[str] = None, known_user_action_text: Optional[str] = None, registered_user_description: Optional[str] = None, title: Optional[str] = None, unknown_user_action_text: Optional[str] = None, unknown_user_description: Optional[str] = None, unregistered_user_description: Optional[str] = None)[source]

Bases: object

Localized text relevant to a given EMail setting in a given localization.

Extra settings specifically for subscriptions.

description: Optional[str] = None
known_user_action_text: Optional[str] = None
registered_user_description: Optional[str] = None
title: Optional[str] = None
to_json() → Mapping[str, Any][source]
unknown_user_action_text: Optional[str] = None
unknown_user_description: Optional[str] = None
unregistered_user_description: Optional[str] = None
class bungieapi.generated.components.schemas.user.EmailOptInDefinition(dependent_subscriptions: Optional[Sequence[bungieapi.generated.components.schemas.user.EmailSubscriptionDefinition]] = None, name: Optional[str] = None, set_by_default: Optional[bool] = None, value: Optional[bungieapi.generated.components.schemas.user.OptInFlags] = None)[source]

Bases: object

Defines a single opt-in category: a wide-scoped permission to send emails for the subject related to the opt-in.

dependent_subscriptions: Optional[Sequence[bungieapi.generated.components.schemas.user.EmailSubscriptionDefinition]] = None
name: Optional[str] = None
set_by_default: Optional[bool] = None
to_json() → Mapping[str, Any][source]
value: Optional[bungieapi.generated.components.schemas.user.OptInFlags] = None
class bungieapi.generated.components.schemas.user.EmailSettings(opt_in_definitions: Optional[Mapping[str, bungieapi.generated.components.schemas.user.EmailOptInDefinition]] = None, subscription_definitions: Optional[Mapping[str, bungieapi.generated.components.schemas.user.EmailSubscriptionDefinition]] = None, views: Optional[Mapping[str, bungieapi.generated.components.schemas.user.EmailViewDefinition]] = None)[source]

Bases: object

The set of all email subscription/opt-in settings and definitions.

opt_in_definitions: Optional[Mapping[str, bungieapi.generated.components.schemas.user.EmailOptInDefinition]] = None
subscription_definitions: Optional[Mapping[str, bungieapi.generated.components.schemas.user.EmailSubscriptionDefinition]] = None
to_json() → Mapping[str, Any][source]
views: Optional[Mapping[str, bungieapi.generated.components.schemas.user.EmailViewDefinition]] = None
class bungieapi.generated.components.schemas.user.EmailSubscriptionDefinition(localization: Optional[Mapping[str, bungieapi.generated.components.schemas.user.EMailSettingSubscriptionLocalization]] = None, name: Optional[str] = None, value: Optional[int] = None)[source]

Bases: object

Defines a single subscription: permission to send emails for a specific, focused subject (generally timeboxed, such as for a specific release of a product or feature).

localization: Optional[Mapping[str, bungieapi.generated.components.schemas.user.EMailSettingSubscriptionLocalization]] = None
name: Optional[str] = None
to_json() → Mapping[str, Any][source]
value: Optional[int] = None
class bungieapi.generated.components.schemas.user.EmailViewDefinition(name: Optional[str] = None, view_settings: Optional[Sequence[bungieapi.generated.components.schemas.user.EmailViewDefinitionSetting]] = None)[source]

Bases: object

Represents a data-driven view for Email settings.

Web/Mobile UI can use this data to show new EMail settings consistently without further manual work.

name: Optional[str] = None
to_json() → Mapping[str, Any][source]
view_settings: Optional[Sequence[bungieapi.generated.components.schemas.user.EmailViewDefinitionSetting]] = None
class bungieapi.generated.components.schemas.user.EmailViewDefinitionSetting(localization: Optional[Mapping[str, ForwardRef('EMailSettingLocalization')]] = None, name: Optional[str] = None, opt_in_aggregate_value: Optional[ForwardRef('OptInFlags')] = None, set_by_default: Optional[bool] = None, subscriptions: Optional[Sequence[ForwardRef('EmailSubscriptionDefinition')]] = None)[source]

Bases: object

localization: Optional[Mapping[str, bungieapi.generated.components.schemas.user.EMailSettingLocalization]] = None
name: Optional[str] = None
opt_in_aggregate_value: Optional[bungieapi.generated.components.schemas.user.OptInFlags] = None
set_by_default: Optional[bool] = None
subscriptions: Optional[Sequence[bungieapi.generated.components.schemas.user.EmailSubscriptionDefinition]] = None
to_json() → Mapping[str, Any][source]
class bungieapi.generated.components.schemas.user.ExactSearchRequest(display_name: Optional[str] = None, display_name_code: Optional[int] = None)[source]

Bases: object

display_name: Optional[str] = None
display_name_code: Optional[int] = None
to_json() → Mapping[str, Any][source]
class bungieapi.generated.components.schemas.user.GeneralUser(about: Optional[str] = None, blizzard_display_name: Optional[str] = None, cached_bungie_global_display_name: Optional[str] = None, cached_bungie_global_display_name_code: Optional[int] = None, context: Optional[ForwardRef('UserToUserContext')] = None, display_name: Optional[str] = None, fb_display_name: Optional[str] = None, first_access: Optional[str] = None, is_deleted: Optional[bool] = None, last_ban_report_id: Optional[int] = None, last_update: Optional[str] = None, legacy_portal_uid: Optional[int] = None, locale: Optional[str] = None, locale_inherit_default: Optional[bool] = None, membership_id: Optional[int] = None, normalized_name: Optional[str] = None, profile_ban_expire: Optional[str] = None, profile_picture: Optional[int] = None, profile_picture_path: Optional[str] = None, profile_picture_wide_path: Optional[str] = None, profile_theme: Optional[int] = None, profile_theme_name: Optional[str] = None, psn_display_name: Optional[str] = None, show_activity: Optional[bool] = None, show_group_messaging: Optional[bool] = None, stadia_display_name: Optional[str] = None, status_date: Optional[str] = None, status_text: Optional[str] = None, steam_display_name: Optional[str] = None, success_message_flags: Optional[int] = None, twitch_display_name: Optional[str] = None, unique_name: Optional[str] = None, user_title: Optional[int] = None, user_title_display: Optional[str] = None, xbox_display_name: Optional[str] = None)[source]

Bases: object

about: Optional[str] = None
blizzard_display_name: Optional[str] = None
cached_bungie_global_display_name: Optional[str] = None
cached_bungie_global_display_name_code: Optional[int] = None
context: Optional[bungieapi.generated.components.schemas.user.UserToUserContext] = None
display_name: Optional[str] = None
fb_display_name: Optional[str] = None
first_access: Optional[str] = None
is_deleted: Optional[bool] = None
last_ban_report_id: Optional[int] = None
last_update: Optional[str] = None
legacy_portal_uid: Optional[int] = None
locale: Optional[str] = None
locale_inherit_default: Optional[bool] = None
membership_id: Optional[int] = None
normalized_name: Optional[str] = None
profile_ban_expire: Optional[str] = None
profile_picture: Optional[int] = None
profile_picture_path: Optional[str] = None
profile_picture_wide_path: Optional[str] = None
profile_theme: Optional[int] = None
profile_theme_name: Optional[str] = None
psn_display_name: Optional[str] = None
show_activity: Optional[bool] = None
show_group_messaging: Optional[bool] = None
stadia_display_name: Optional[str] = None
status_date: Optional[str] = None
status_text: Optional[str] = None
steam_display_name: Optional[str] = None
success_message_flags: Optional[int] = None
to_json() → Mapping[str, Any][source]
twitch_display_name: Optional[str] = None
unique_name: Optional[str] = None
user_title: Optional[int] = None
user_title_display: Optional[str] = None
xbox_display_name: Optional[str] = None
class bungieapi.generated.components.schemas.user.HardLinkedUserMembership(cross_save_overridden_membership_id: Optional[int] = None, cross_save_overridden_type: Optional[ForwardRef('BungieMembershipType')] = None, membership_id: Optional[int] = None, membership_type: Optional[ForwardRef('BungieMembershipType')] = None)[source]

Bases: object

cross_save_overridden_membership_id: Optional[int] = None
cross_save_overridden_type: Optional[bungieapi.generated.components.schemas.BungieMembershipType] = None
membership_id: Optional[int] = None
membership_type: Optional[bungieapi.generated.components.schemas.BungieMembershipType] = None
to_json() → Mapping[str, Any][source]
class bungieapi.generated.components.schemas.user.OptInFlags(value)[source]

Bases: enum.Enum

An enumeration.

CAREERS = 256
CUSTOMER_SERVICE = 16
MARKETING = 4
NEWSLETTER = 1
NONE = 0
PLAY_TESTS = 64
PLAY_TESTS_LOCAL = 128
SOCIAL = 32
SYSTEM = 2
USER_RESEARCH = 8
class bungieapi.generated.components.schemas.user.UserInfoCard(applicable_membership_types: Optional[Sequence[bungieapi.generated.components.schemas.BungieMembershipType]] = None, bungie_global_display_name: Optional[str] = None, bungie_global_display_name_code: Optional[int] = None, cross_save_override: Optional[bungieapi.generated.components.schemas.BungieMembershipType] = None, display_name: Optional[str] = None, icon_path: Optional[str] = None, is_public: Optional[bool] = None, membership_id: Optional[int] = None, membership_type: Optional[bungieapi.generated.components.schemas.BungieMembershipType] = None, supplemental_display_name: Optional[str] = None)[source]

Bases: object

This contract supplies basic information commonly used to display a minimal amount of information about a user.

Take care to not add more properties here unless the property applies in all (or at least the majority) of the situations where UserInfoCard is used. Avoid adding game specific or platform specific details here. In cases where UserInfoCard is a subset of the data needed in a contract, use UserInfoCard as a property of other contracts.

applicable_membership_types: Optional[Sequence[bungieapi.generated.components.schemas.BungieMembershipType]] = None
bungie_global_display_name: Optional[str] = None
bungie_global_display_name_code: Optional[int] = None
cross_save_override: Optional[bungieapi.generated.components.schemas.BungieMembershipType] = None
display_name: Optional[str] = None
icon_path: Optional[str] = None
is_public: Optional[bool] = None
membership_id: Optional[int] = None
membership_type: Optional[bungieapi.generated.components.schemas.BungieMembershipType] = None
supplemental_display_name: Optional[str] = None
to_json() → Mapping[str, Any][source]
class bungieapi.generated.components.schemas.user.UserMembership(bungie_global_display_name: Optional[str] = None, bungie_global_display_name_code: Optional[int] = None, display_name: Optional[str] = None, membership_id: Optional[int] = None, membership_type: Optional[bungieapi.generated.components.schemas.BungieMembershipType] = None)[source]

Bases: object

Very basic info about a user as returned by the Account server.

bungie_global_display_name: Optional[str] = None
bungie_global_display_name_code: Optional[int] = None
display_name: Optional[str] = None
membership_id: Optional[int] = None
membership_type: Optional[bungieapi.generated.components.schemas.BungieMembershipType] = None
to_json() → Mapping[str, Any][source]
class bungieapi.generated.components.schemas.user.UserMembershipData(bungie_net_user: Optional[ForwardRef('GeneralUser')] = None, destiny_memberships: Optional[Sequence[ForwardRef('GroupUserInfoCard')]] = None, primary_membership_id: Optional[int] = None)[source]

Bases: object

bungie_net_user: Optional[bungieapi.generated.components.schemas.user.GeneralUser] = None
destiny_memberships: Optional[Sequence[bungieapi.generated.components.schemas.groups_v2.GroupUserInfoCard]] = None
primary_membership_id: Optional[int] = None
to_json() → Mapping[str, Any][source]
class bungieapi.generated.components.schemas.user.UserSearchPrefixRequest(display_name_prefix: Optional[str] = None)[source]

Bases: object

display_name_prefix: Optional[str] = None
to_json() → Mapping[str, Any][source]
class bungieapi.generated.components.schemas.user.UserSearchResponse(has_more: Optional[bool] = None, page: Optional[int] = None, search_results: Optional[Sequence[ForwardRef('UserSearchResponseDetail')]] = None)[source]

Bases: object

has_more: Optional[bool] = None
page: Optional[int] = None
search_results: Optional[Sequence[bungieapi.generated.components.schemas.user.UserSearchResponseDetail]] = None
to_json() → Mapping[str, Any][source]
class bungieapi.generated.components.schemas.user.UserSearchResponseDetail(bungie_global_display_name: Optional[str] = None, bungie_global_display_name_code: Optional[int] = None, bungie_net_membership_id: Optional[int] = None, destiny_memberships: Optional[Sequence[ForwardRef('UserInfoCard')]] = None)[source]

Bases: object

bungie_global_display_name: Optional[str] = None
bungie_global_display_name_code: Optional[int] = None
bungie_net_membership_id: Optional[int] = None
destiny_memberships: Optional[Sequence[bungieapi.generated.components.schemas.user.UserInfoCard]] = None
to_json() → Mapping[str, Any][source]
class bungieapi.generated.components.schemas.user.UserToUserContext(global_ignore_end_date: Optional[str] = None, ignore_status: Optional[ForwardRef('IgnoreResponse')] = None, is_following: Optional[bool] = None)[source]

Bases: object

global_ignore_end_date: Optional[str] = None
ignore_status: Optional[bungieapi.generated.components.schemas.ignores.IgnoreResponse] = None
is_following: Optional[bool] = None
to_json() → Mapping[str, Any][source]