bungieapi.generated.components.schemas.content package

Submodules

bungieapi.generated.components.schemas.content.models module

class bungieapi.generated.components.schemas.content.models.ContentPreview(item_in_set: Optional[bool] = None, name: Optional[str] = None, path: Optional[str] = None, set_nesting: Optional[int] = None, set_tag: Optional[str] = None, use_set_id: Optional[int] = None)[source]

Bases: object

item_in_set: Optional[bool] = None
name: Optional[str] = None
path: Optional[str] = None
set_nesting: Optional[int] = None
set_tag: Optional[str] = None
to_json() → Mapping[str, Any][source]
use_set_id: Optional[int] = None
class bungieapi.generated.components.schemas.content.models.ContentPropertyDataTypeEnum(value)[source]

Bases: enum.Enum

An enumeration.

COLOR = 14
CONTENT = 6
DATE = 11
DESTINY_CONTENT = 13
DROPDOWN = 3
FILE = 9
FOLDER_SET = 10
HTML = 2
JSON = 5
LIST = 4
MULTILINE_PLAINTEXT = 12
NONE = 0
PLAINTEXT = 1
REPRESENTATION = 7
SET = 8
class bungieapi.generated.components.schemas.content.models.ContentTypeDefaultValue(default_value: Optional[str] = None, when_clause: Optional[str] = None, when_value: Optional[str] = None)[source]

Bases: object

default_value: Optional[str] = None
to_json() → Mapping[str, Any][source]
when_clause: Optional[str] = None
when_value: Optional[str] = None
class bungieapi.generated.components.schemas.content.models.ContentTypeDescription(allow_comments: Optional[bool] = None, auto_english_property_fallback: Optional[bool] = None, bind_identifier_to_property: Optional[str] = None, bound_regex: Optional[str] = None, bulk_uploadable: Optional[bool] = None, c_type: Optional[str] = None, content_description: Optional[str] = None, force_identifier_binding: Optional[bool] = None, name: Optional[str] = None, preview_image: Optional[str] = None, previews: Optional[Sequence[ForwardRef('ContentPreview')]] = None, priority: Optional[int] = None, properties: Optional[Sequence[ForwardRef('ContentTypeProperty')]] = None, property_sections: Optional[Sequence[ForwardRef('ContentTypePropertySection')]] = None, reminder: Optional[str] = None, show_in_content_editor: Optional[bool] = None, suppress_cms_path: Optional[bool] = None, tag_metadata: Optional[Sequence[ForwardRef('TagMetadataDefinition')]] = None, tag_metadata_items: Optional[Mapping[str, ForwardRef('TagMetadataItem')]] = None, type_of: Optional[str] = None, usage_examples: Optional[Sequence[str]] = None)[source]

Bases: object

allow_comments: Optional[bool] = None
auto_english_property_fallback: Optional[bool] = None
bind_identifier_to_property: Optional[str] = None
bound_regex: Optional[str] = None
bulk_uploadable: Optional[bool] = None
c_type: Optional[str] = None
content_description: Optional[str] = None
force_identifier_binding: Optional[bool] = None
name: Optional[str] = None
preview_image: Optional[str] = None
previews: Optional[Sequence[bungieapi.generated.components.schemas.content.models.ContentPreview]] = None
priority: Optional[int] = None
properties: Optional[Sequence[bungieapi.generated.components.schemas.content.models.ContentTypeProperty]] = None
property_sections: Optional[Sequence[bungieapi.generated.components.schemas.content.models.ContentTypePropertySection]] = None
reminder: Optional[str] = None
show_in_content_editor: Optional[bool] = None
suppress_cms_path: Optional[bool] = None
tag_metadata: Optional[Sequence[bungieapi.generated.components.schemas.content.models.TagMetadataDefinition]] = None
tag_metadata_items: Optional[Mapping[str, bungieapi.generated.components.schemas.content.models.TagMetadataItem]] = None
to_json() → Mapping[str, Any][source]
type_of: Optional[str] = None
usage_examples: Optional[Sequence[str]] = None
class bungieapi.generated.components.schemas.content.models.ContentTypeProperty(attributes: Optional[Mapping[str, str]] = None, bind_to_property: Optional[str] = None, bound_regex: Optional[str] = None, child_properties: Optional[Sequence[ForwardRef('ContentTypeProperty')]] = None, content_type_allowed: Optional[str] = None, datatype: Optional[ForwardRef('ContentPropertyDataTypeEnum')] = None, default_values: Optional[Sequence[ForwardRef('ContentTypeDefaultValue')]] = None, enabled: Optional[bool] = None, entitytype: Optional[str] = None, fallback: Optional[bool] = None, is_combo: Optional[bool] = None, is_external_allowed: Optional[bool] = None, is_image: Optional[bool] = None, is_title: Optional[bool] = None, is_video: Optional[bool] = None, legal_content_types: Optional[Sequence[str]] = None, localizable: Optional[bool] = None, max_byte_length: Optional[int] = None, max_file_size: Optional[int] = None, max_height: Optional[int] = None, max_length: Optional[int] = None, max_width: Optional[int] = None, min_height: Optional[int] = None, min_width: Optional[int] = None, name: Optional[str] = None, order: Optional[int] = None, property_description: Optional[str] = None, property_section: Optional[str] = None, readable_name: Optional[str] = None, regexp: Optional[str] = None, representation_selection: Optional[Mapping[str, str]] = None, representation_validation_string: Optional[str] = None, required: Optional[bool] = None, root_property_name: Optional[str] = None, rss_attribute: Optional[str] = None, suppress_property: Optional[bool] = None, validate_as: Optional[str] = None, value: Optional[str] = None, visible: Optional[bool] = None, visible_dependency: Optional[str] = None, visible_on: Optional[str] = None, weight: Optional[int] = None)[source]

Bases: object

attributes: Optional[Mapping[str, str]] = None
bind_to_property: Optional[str] = None
bound_regex: Optional[str] = None
child_properties: Optional[Sequence[bungieapi.generated.components.schemas.content.models.ContentTypeProperty]] = None
content_type_allowed: Optional[str] = None
datatype: Optional[bungieapi.generated.components.schemas.content.models.ContentPropertyDataTypeEnum] = None
default_values: Optional[Sequence[bungieapi.generated.components.schemas.content.models.ContentTypeDefaultValue]] = None
enabled: Optional[bool] = None
entitytype: Optional[str] = None
fallback: Optional[bool] = None
is_combo: Optional[bool] = None
is_external_allowed: Optional[bool] = None
is_image: Optional[bool] = None
is_title: Optional[bool] = None
is_video: Optional[bool] = None
legal_content_types: Optional[Sequence[str]] = None
localizable: Optional[bool] = None
max_byte_length: Optional[int] = None
max_file_size: Optional[int] = None
max_height: Optional[int] = None
max_length: Optional[int] = None
max_width: Optional[int] = None
min_height: Optional[int] = None
min_width: Optional[int] = None
name: Optional[str] = None
order: Optional[int] = None
property_description: Optional[str] = None
property_section: Optional[str] = None
readable_name: Optional[str] = None
regexp: Optional[str] = None
representation_selection: Optional[Mapping[str, str]] = None
representation_validation_string: Optional[str] = None
required: Optional[bool] = None
root_property_name: Optional[str] = None
rss_attribute: Optional[str] = None
suppress_property: Optional[bool] = None
to_json() → Mapping[str, Any][source]
validate_as: Optional[str] = None
value: Optional[str] = None
visible: Optional[bool] = None
visible_dependency: Optional[str] = None
visible_on: Optional[str] = None
weight: Optional[int] = None
class bungieapi.generated.components.schemas.content.models.ContentTypePropertySection(collapsed: Optional[bool] = None, name: Optional[str] = None, readable_name: Optional[str] = None)[source]

Bases: object

collapsed: Optional[bool] = None
name: Optional[str] = None
readable_name: Optional[str] = None
to_json() → Mapping[str, Any][source]
class bungieapi.generated.components.schemas.content.models.TagMetadataDefinition(datatype: Optional[str] = None, description: Optional[str] = None, is_required: Optional[bool] = None, items: Optional[Sequence[ForwardRef('TagMetadataItem')]] = None, name: Optional[str] = None, order: Optional[int] = None)[source]

Bases: object

datatype: Optional[str] = None
description: Optional[str] = None
is_required: Optional[bool] = None
items: Optional[Sequence[bungieapi.generated.components.schemas.content.models.TagMetadataItem]] = None
name: Optional[str] = None
order: Optional[int] = None
to_json() → Mapping[str, Any][source]
class bungieapi.generated.components.schemas.content.models.TagMetadataItem(description: Optional[str] = None, groups: Optional[Sequence[str]] = None, is_default: Optional[bool] = None, name: Optional[str] = None, tag_text: Optional[str] = None)[source]

Bases: object

description: Optional[str] = None
groups: Optional[Sequence[str]] = None
is_default: Optional[bool] = None
name: Optional[str] = None
tag_text: Optional[str] = None
to_json() → Mapping[str, Any][source]

Module contents

class bungieapi.generated.components.schemas.content.CommentSummary(comment_count: Optional[int] = None, topic_id: Optional[int] = None)[source]

Bases: object

comment_count: Optional[int] = None
to_json() → Mapping[str, Any][source]
topic_id: Optional[int] = None
class bungieapi.generated.components.schemas.content.ContentItemPublicContract(allow_comments: Optional[bool] = None, author: Optional[ForwardRef('GeneralUser')] = None, auto_english_property_fallback: Optional[bool] = None, c_type: Optional[str] = None, cms_path: Optional[str] = None, comment_summary: Optional[ForwardRef('CommentSummary')] = None, content_id: Optional[int] = None, creation_date: Optional[str] = None, has_age_gate: Optional[bool] = None, minimum_age: Optional[int] = None, modify_date: Optional[str] = None, properties: Optional[Mapping[str, Any]] = None, rating_image_path: Optional[str] = None, representations: Optional[Sequence[ForwardRef('ContentRepresentation')]] = None, tags: Optional[Sequence[str]] = None)[source]

Bases: object

allow_comments: Optional[bool] = None
author: Optional[bungieapi.generated.components.schemas.user.GeneralUser] = None
auto_english_property_fallback: Optional[bool] = None
c_type: Optional[str] = None
cms_path: Optional[str] = None
comment_summary: Optional[bungieapi.generated.components.schemas.content.CommentSummary] = None
content_id: Optional[int] = None
creation_date: Optional[str] = None
has_age_gate: Optional[bool] = None
minimum_age: Optional[int] = None
modify_date: Optional[str] = None
properties: Optional[Mapping[str, Any]] = None
rating_image_path: Optional[str] = None
representations: Optional[Sequence[bungieapi.generated.components.schemas.content.ContentRepresentation]] = None
tags: Optional[Sequence[str]] = None
to_json() → Mapping[str, Any][source]
class bungieapi.generated.components.schemas.content.ContentRepresentation(name: Optional[str] = None, path: Optional[str] = None, validation_string: Optional[str] = None)[source]

Bases: object

name: Optional[str] = None
path: Optional[str] = None
to_json() → Mapping[str, Any][source]
validation_string: Optional[str] = None