cyclonedx.model.contact
=======================

.. py:module:: cyclonedx.model.contact


Classes
-------

.. autoapisummary::

   cyclonedx.model.contact.PostalAddress
   cyclonedx.model.contact.OrganizationalContact
   cyclonedx.model.contact.OrganizationalEntity


Module Contents
---------------

.. py:class:: PostalAddress

   This is our internal representation of the `postalAddressType` complex type that can be used in multiple places
   within a CycloneDX BOM document.

   .. note::
       See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.7/xml/#type_postalAddressType


   .. py:attribute:: bom_ref
      :type:  cyclonedx.model.bom_ref.BomRef


   .. py:attribute:: country
      :type:  Optional[str]


   .. py:attribute:: region
      :type:  Optional[str]


   .. py:attribute:: locality
      :type:  Optional[str]


   .. py:attribute:: post_office_box_number
      :type:  Optional[str]


   .. py:attribute:: postal_code
      :type:  Optional[str]


   .. py:attribute:: street_address
      :type:  Optional[str]


.. py:class:: OrganizationalContact

   This is our internal representation of the `organizationalContact` complex type that can be used in multiple places
   within a CycloneDX BOM document.

   .. note::
       See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.7/xml/#type_organizationalContact


   .. py:attribute:: bom_ref
      :type:  cyclonedx.model.bom_ref.BomRef


   .. py:attribute:: name
      :type:  Optional[str]


   .. py:attribute:: email
      :type:  Optional[str]


   .. py:attribute:: phone
      :type:  Optional[str]


.. py:class:: OrganizationalEntity

   This is our internal representation of the `organizationalEntity` complex type that can be used in multiple places
   within a CycloneDX BOM document.

   .. note::
       See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.7/xml/#type_organizationalEntity


   .. py:attribute:: bom_ref
      :type:  cyclonedx.model.bom_ref.BomRef


   .. py:attribute:: name
      :type:  Optional[str]


   .. py:attribute:: address
      :type:  Optional[PostalAddress]


   .. py:attribute:: urls
      :type:  SortedSet[XsUri]


   .. py:attribute:: contacts
      :type:  SortedSet[OrganizationalContact]