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(*, bom_ref: Optional[Union[str, cyclonedx.model.bom_ref.BomRef]] = None, country: Optional[str] = None, region: Optional[str] = None, locality: Optional[str] = None, post_office_box_number: Optional[str] = None, postal_code: Optional[str] = None, street_address: Optional[str] = None)

   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:property:: country
      :type: Optional[str]


      The country name or the two-letter ISO 3166-1 country code.

      Returns:
           `str` or `None`



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


      The region or state in the country. For example, Texas.

      Returns:
           `str` or `None`



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


      The locality or city within the country. For example, Austin.

      Returns:
           `str` or `None`



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


      The post office box number. For example, 901.

      Returns:
           `str` or `None`



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


      The postal code. For example, 78758.

      Returns:
           `str` or `None`



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


      The street address. For example, 100 Main Street.

      Returns:
           `str` or `None`



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


      An optional identifier which can be used to reference the component elsewhere in the BOM. Every bom-ref MUST be
      unique within the BOM.

      Returns:
          `BomRef`



.. py:class:: OrganizationalContact(*, bom_ref: Optional[Union[str, cyclonedx.model.bom_ref.BomRef]] = None, name: Optional[str] = None, phone: Optional[str] = None, email: Optional[str] = None)

   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:property:: name
      :type: Optional[str]


      Get the name of the contact.

      Returns:
          `str` if set else `None`



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


      Get the email of the contact.

      Returns:
          `str` if set else `None`



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


      Get the phone of the contact.

      Returns:
          `str` if set else `None`



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


      An optional identifier which can be used to reference the component elsewhere in the BOM. Every bom-ref MUST be
      unique within the BOM.

      Returns:
          `BomRef`



.. py:class:: OrganizationalEntity(*, bom_ref: Optional[Union[str, cyclonedx.model.bom_ref.BomRef]] = None, name: Optional[str] = None, urls: Optional[collections.abc.Iterable[cyclonedx.model.XsUri]] = None, contacts: Optional[collections.abc.Iterable[OrganizationalContact]] = None, address: Optional[PostalAddress] = None)

   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:property:: name
      :type: Optional[str]


      Get the name of the organization.

      Returns:
          `str` if set else `None`



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


      The physical address (location) of the organization.

      Returns:
          `PostalAddress` or `None`



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


      Get a list of URLs of the organization. Multiple URLs are allowed.

      Returns:
          Set of `XsUri`



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


      Get a list of contact person at the organization. Multiple contacts are allowed.

      Returns:
          Set of `OrganizationalContact`



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


      An optional identifier which can be used to reference the component elsewhere in the BOM. Every bom-ref MUST be
      unique within the BOM.

      Returns:
          `BomRef`