site
konigle.models.core.site
¶
Site models for the Konigle SDK.
This module provides models for site/website resources including site details, mutation data, and list representations.
Site
¶
Bases: BaseResource
Site resource model.
Represents a complete site/website with all available fields from the detail endpoint.
address1 = Field(default=None, title='Address Line 1', description="First line of the site's address.")
class-attribute
instance-attribute
¶
First line of the site's address.
address2 = Field(default=None, title='Address Line 2', description="Second line of the site's address.")
class-attribute
instance-attribute
¶
Second line of the site's address.
asset_bucket = Field(default=None, title='Asset Bucket', description='Storage bucket for site assets.')
class-attribute
instance-attribute
¶
Storage bucket for site assets.
asset_domain = Field(default=None, title='Asset Domain', description='CDN domain for serving site assets.')
class-attribute
instance-attribute
¶
CDN domain for serving site assets.
city = Field(default=None, title='City', description="City of the site's address.")
class-attribute
instance-attribute
¶
City of the site's address.
country = Field(default=None, title='Country', description="Country of the site's address.")
class-attribute
instance-attribute
¶
Country of the site's address.
currency = Field(default=None, title='Currency', description='Default currency code for the site.')
class-attribute
instance-attribute
¶
Default currency code for the site.
domain = Field(..., title='Domain', description='The primary domain of the site.')
class-attribute
instance-attribute
¶
The primary domain of the site.
email = Field(default=None, title='Email', description='Contact email address for the site.')
class-attribute
instance-attribute
¶
Contact email address for the site.
id
property
¶
Alias for uid to provide uniform interface.
konigle_domain = Field(..., title='Konigle Domain', description='The konigle.net domain.')
class-attribute
instance-attribute
¶
The konigle.net domain.
name = Field(..., title='Site Name', description='The name of the website.')
class-attribute
instance-attribute
¶
The name of the site/website.
password_enabled = Field(default=False, title='Password Enabled', description='Whether password protection is enabled for the site.')
class-attribute
instance-attribute
¶
Whether password protection is enabled for the site.
phone = Field(default=None, title='Phone Number', description='Contact phone number for the site.')
class-attribute
instance-attribute
¶
Contact phone number for the site.
province = Field(default=None, title='Province/State', description="Province or state of the site's address.")
class-attribute
instance-attribute
¶
Province or state of the site's address.
uid = Field(..., title='UID', description='Unique identifier of the site.')
class-attribute
instance-attribute
¶
Unique identifier of the site.
SiteUpdate
¶
Bases: UpdateModel
Site update model.
Defines fields that can be updated for a site. Only includes mutable fields from the mutation serializer.
address1 = Field(default=None, title='Address Line 1', description="First line of the site's address.")
class-attribute
instance-attribute
¶
First line of the site's address.
address2 = Field(default=None, title='Address Line 2', description="Second line of the site's address.")
class-attribute
instance-attribute
¶
Second line of the site's address.
city = Field(default=None, title='City', description="City of the site's address.")
class-attribute
instance-attribute
¶
City of the site's address.
country = Field(default=None, title='Country', description="Country of the site's address.")
class-attribute
instance-attribute
¶
Country of the site's address.
name = Field(default=None, title='Site Name', description='The name of the site/website.')
class-attribute
instance-attribute
¶
The name of the site/website.
phone = Field(default=None, title='Phone Number', description='Contact phone number for the site.')
class-attribute
instance-attribute
¶
Contact phone number for the site.
province = Field(default=None, title='Province/State', description="Province or state of the site's address.")
class-attribute
instance-attribute
¶
Province or state of the site's address.