Skip to content

Latest commit

 

History

History
34 lines (25 loc) · 2.2 KB

SectionResponseSchema.md

File metadata and controls

34 lines (25 loc) · 2.2 KB

SectionResponseSchema

One entry of the ordered section index. Carries no units — every unit names its section by sectionId, so a unit appears exactly once no matter how the sections are arranged. id is opaque and must never be parsed. What a section is comes from kind plus its companion field: entity for an entity-backed section, systemLabel for a computed one. A new sectioning dimension (floor, building) adds an entity.type value rather than a new section shape.

Properties

Name Type Description Notes
id str Opaque section id. Never parsed by the client.
kind str `entity`: backed by a domain record, see `entity`. `custom`: named by an admin. `system`: computed by the server, see `systemLabel`.
label str Display label, resolved server-side and rendered verbatim. Not localized: property-authored labels come back as authored, and the two server-generated labels ship English here plus a `systemLabel` token for the client to translate. Rendered verbatim.
system_label str Which computed section this is, for clients that need to treat one specially — the uncategorized tail is default-collapsed, for instance. [optional]
entity SectionEntityResponseSchema [optional]

Example

from cloudbeds_pms.models.section_response_schema import SectionResponseSchema

# TODO update the JSON string below
json = "{}"
# create an instance of SectionResponseSchema from a JSON string
section_response_schema_instance = SectionResponseSchema.from_json(json)
# print the JSON string representation of the object
print(SectionResponseSchema.to_json())

# convert the object into a dict
section_response_schema_dict = section_response_schema_instance.to_dict()
# create an instance of SectionResponseSchema from a dict
section_response_schema_from_dict = SectionResponseSchema.from_dict(section_response_schema_dict)

[Back to Model list] [Back to API list] [Back to README]