brightsites_sdk.models ====================== .. py:module:: brightsites_sdk.models .. autoapi-nested-parse:: Brightsites API models. Classes ------- .. autoapisummary:: brightsites_sdk.models._BaseModel brightsites_sdk.models.PaginationMeta brightsites_sdk.models.PaginatedResponse brightsites_sdk.models.OrderSummary brightsites_sdk.models.OrdersList brightsites_sdk.models.ProductSubOption brightsites_sdk.models.ProductSubOptionsList brightsites_sdk.models.ProductOption brightsites_sdk.models.ProductOptionsList brightsites_sdk.models.ProductCategory brightsites_sdk.models.ProductVendor brightsites_sdk.models.ProductInventory brightsites_sdk.models.ProductSummary brightsites_sdk.models.ProductsList brightsites_sdk.models.Product Module Contents --------------- .. py:class:: _BaseModel(/, **data: Any) Bases: :py:obj:`pydantic.BaseModel` Base model for all Brightsites models. .. py:class:: PaginationMeta(/, **data: Any) Bases: :py:obj:`_BaseModel` Pagination metadata. .. py:attribute:: total :type: int .. py:attribute:: offset :type: int .. py:attribute:: limit :type: int .. py:class:: PaginatedResponse(/, **data: Any) Bases: :py:obj:`_BaseModel` A paginated response. .. py:attribute:: meta :type: PaginationMeta .. py:class:: OrderSummary(/, **data: Any) Bases: :py:obj:`_BaseModel` Short view of an order. .. py:attribute:: created_at :type: datetime.datetime :value: None .. py:attribute:: updated_at :type: datetime.datetime :value: None .. py:attribute:: order_id :type: int .. py:attribute:: shipping_method :type: str .. py:attribute:: tracking :type: str .. py:attribute:: status :type: str .. py:attribute:: customer :type: pydantic.EmailStr .. py:class:: OrdersList(/, **data: Any) Bases: :py:obj:`PaginatedResponse` A list of orders. .. py:attribute:: orders :type: list[OrderSummary] .. py:class:: ProductSubOption(/, **data: Any) Bases: :py:obj:`_BaseModel` Sub options for a product. .. py:attribute:: id :type: int .. py:attribute:: name :type: str .. py:attribute:: sub_sku :type: str | None .. py:attribute:: image_src :type: str | None .. py:attribute:: price_modifier :type: str .. py:attribute:: position :type: int .. py:attribute:: product_option_id :type: int .. py:class:: ProductSubOptionsList(/, **data: Any) Bases: :py:obj:`_BaseModel` A list of sub options. .. py:attribute:: sub_options :type: list[ProductSubOption] .. py:class:: ProductOption(/, **data: Any) Bases: :py:obj:`_BaseModel` A option for a product. .. py:attribute:: id :type: int .. py:attribute:: name :type: str .. py:attribute:: friendly_name :type: str .. py:attribute:: option_type :type: str .. py:attribute:: price_modifier_type :type: str .. py:attribute:: show_in_inventory :type: bool .. py:attribute:: show_as_thumbs :type: bool .. py:attribute:: include_in_images :type: bool .. py:attribute:: required :type: bool .. py:attribute:: multiple_quantity :type: bool .. py:attribute:: position :type: int .. py:class:: ProductOptionsList(/, **data: Any) Bases: :py:obj:`_BaseModel` A list of options for a product. .. py:attribute:: enabled :type: bool .. py:attribute:: options :type: list[ProductOption] .. py:class:: ProductCategory(/, **data: Any) Bases: :py:obj:`_BaseModel` Product category. .. py:attribute:: id :type: int .. py:attribute:: name :type: str .. py:class:: ProductVendor(/, **data: Any) Bases: :py:obj:`_BaseModel` Product vendor. .. py:attribute:: id :type: int .. py:attribute:: name :type: str .. py:class:: ProductInventory(/, **data: Any) Bases: :py:obj:`_BaseModel` Inventory information for a product. .. py:attribute:: id :type: int .. py:attribute:: inventory :type: int .. py:attribute:: trigger :type: int .. py:attribute:: track :type: bool .. py:attribute:: allow_negative :type: bool .. py:attribute:: sub_sku :type: str .. py:attribute:: sub_option_ids :type: list[int] .. py:class:: ProductSummary(/, **data: Any) Bases: :py:obj:`_BaseModel` Short view of a product. .. py:attribute:: created_at :type: datetime.datetime :value: None .. py:attribute:: updated_at :type: datetime.datetime :value: None .. py:attribute:: id :type: int .. py:attribute:: name :type: str .. py:attribute:: sku :type: str .. py:attribute:: internal_id :type: str | None .. py:attribute:: origin_address_id :type: int | None .. py:attribute:: new_product :type: bool .. py:attribute:: new_expires_at :type: datetime.datetime | None :value: None .. py:attribute:: categories :type: list[ProductCategory] .. py:attribute:: vendors :type: list[ProductVendor] .. py:attribute:: active :type: bool .. py:class:: ProductsList(/, **data: Any) Bases: :py:obj:`PaginatedResponse` A list of products. .. py:attribute:: products :type: list[ProductSummary] .. py:class:: Product(/, **data: Any) Bases: :py:obj:`_BaseModel` A product. .. py:attribute:: id :type: int .. py:attribute:: name :type: str .. py:attribute:: sku :type: str .. py:attribute:: sku_separator :type: str .. py:attribute:: internal_id :type: str | None .. py:attribute:: origin_address_id :type: int | None .. py:attribute:: new_product :type: bool .. py:attribute:: new_expires_at :type: datetime.datetime | None :value: None .. py:attribute:: base_price :type: str .. py:attribute:: retail_price :type: str | None .. py:attribute:: cost :type: str | None .. py:attribute:: setup_charge :type: str | None .. py:attribute:: minimum_order_quantity :type: int | None .. py:attribute:: maximum_order_quantity :type: int | None .. py:attribute:: weight :type: str | None .. py:attribute:: width :type: str | None .. py:attribute:: height :type: str | None .. py:attribute:: length :type: str | None .. py:attribute:: shipping_modifier :type: str | None .. py:attribute:: meta_title :type: str | None .. py:attribute:: meta_description :type: str | None .. py:attribute:: meta_keywords :type: str | None .. py:attribute:: custom_url :type: str | None .. py:attribute:: description :type: str | None .. py:attribute:: active :type: bool .. py:attribute:: featured :type: bool .. py:attribute:: tax_exempt :type: bool .. py:attribute:: shipping_exempt :type: bool .. py:attribute:: categories :type: list[ProductCategory] .. py:attribute:: vendors :type: list[ProductVendor] .. py:attribute:: options :type: list[ProductOption] .. py:attribute:: sub_options :type: list[ProductSubOption] .. py:attribute:: inventories :type: list[ProductInventory] .. py:attribute:: enable_quantity_discount :type: bool .. py:attribute:: related_products_type :type: str .. py:attribute:: enable_related_products :type: bool .. py:attribute:: enable_product_personalization :type: bool .. py:attribute:: enable_inventory :type: bool .. py:attribute:: enable_logo_locations :type: bool .. py:attribute:: enable_product_options :type: bool .. py:attribute:: primary_category_id :type: int | None .. py:attribute:: vendor_inventory_enabled :type: bool .. py:attribute:: inventory_vendor_id :type: int | None .. py:attribute:: tax_code :type: str | None .. py:attribute:: note :type: str | None .. py:attribute:: created_at :type: datetime.datetime | None :value: None .. py:attribute:: updated_at :type: datetime.datetime | None :value: None