leaf_engine.domain.enums
========================

.. py:module:: leaf_engine.domain.enums


Classes
-------

.. autoapisummary::

   leaf_engine.domain.enums.CAN
   leaf_engine.domain.enums.CountrySubdivision
   leaf_engine.domain.enums.CountrySubdivisionEnum
   leaf_engine.domain.enums.MEX
   leaf_engine.domain.enums.USA


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

.. py:class:: CAN

   Bases: :py:obj:`enum.Enum`


   Generic enumeration.

   Derive from this class to define new enumerations.


   .. py:attribute:: AB


   .. py:attribute:: BC


   .. py:attribute:: MB


   .. py:attribute:: NB


   .. py:attribute:: NL


   .. py:attribute:: NS


   .. py:attribute:: NT


   .. py:attribute:: NU


   .. py:attribute:: ON


   .. py:attribute:: PE


   .. py:attribute:: QC


   .. py:attribute:: SK


   .. py:attribute:: YT


.. py:class:: CountrySubdivision

   .. py:attribute:: category
      :type:  str


   .. py:attribute:: code
      :type:  str


   .. py:attribute:: country
      :type:  str


   .. py:attribute:: iso_3166_code
      :type:  str


   .. py:attribute:: name
      :type:  str


.. py:class:: CountrySubdivisionEnum

   Bases: :py:obj:`enum.EnumMeta`


   Metaclass for Enum


   .. py:method:: __getattribute__(name)


   .. py:method:: all_subdivisions(attr='code')


   .. py:method:: has_subdivision(value, attr='code')


   .. py:property:: country_code


.. py:class:: MEX

   Bases: :py:obj:`enum.Enum`


   Generic enumeration.

   Derive from this class to define new enumerations.


   .. py:attribute:: AG


   .. py:attribute:: BN


   .. py:attribute:: BS


   .. py:attribute:: CH


   .. py:attribute:: CI


   .. py:attribute:: CL


   .. py:attribute:: CP


   .. py:attribute:: CS


   .. py:attribute:: DF


   .. py:attribute:: DG


   .. py:attribute:: GE


   .. py:attribute:: GJ


   .. py:attribute:: HD


   .. py:attribute:: JA


   .. py:attribute:: MC


   .. py:attribute:: MR


   .. py:attribute:: MX


   .. py:attribute:: NA


   .. py:attribute:: NL


   .. py:attribute:: OA


   .. py:attribute:: PU


   .. py:attribute:: QE


   .. py:attribute:: QI


   .. py:attribute:: SI


   .. py:attribute:: SL


   .. py:attribute:: SO


   .. py:attribute:: TA


   .. py:attribute:: TB


   .. py:attribute:: TL


   .. py:attribute:: VC


   .. py:attribute:: YU


   .. py:attribute:: ZA


.. py:class:: USA

   Bases: :py:obj:`enum.Enum`


   Generic enumeration.

   Derive from this class to define new enumerations.


   .. py:attribute:: AK


   .. py:attribute:: AL


   .. py:attribute:: AR


   .. py:attribute:: AS


   .. py:attribute:: AZ


   .. py:attribute:: CA


   .. py:attribute:: CO


   .. py:attribute:: CT


   .. py:attribute:: DC


   .. py:attribute:: DE


   .. py:attribute:: FL


   .. py:attribute:: GA


   .. py:attribute:: GU


   .. py:attribute:: HI


   .. py:attribute:: IA


   .. py:attribute:: ID


   .. py:attribute:: IL


   .. py:attribute:: IN


   .. py:attribute:: KS


   .. py:attribute:: KY


   .. py:attribute:: LA


   .. py:attribute:: MA


   .. py:attribute:: MD


   .. py:attribute:: ME


   .. py:attribute:: MI


   .. py:attribute:: MN


   .. py:attribute:: MO


   .. py:attribute:: MP


   .. py:attribute:: MS


   .. py:attribute:: MT


   .. py:attribute:: NC


   .. py:attribute:: ND


   .. py:attribute:: NE


   .. py:attribute:: NH


   .. py:attribute:: NJ


   .. py:attribute:: NM


   .. py:attribute:: NV


   .. py:attribute:: NY


   .. py:attribute:: OH


   .. py:attribute:: OK


   .. py:attribute:: OR


   .. py:attribute:: PA


   .. py:attribute:: PR


   .. py:attribute:: RI


   .. py:attribute:: SC


   .. py:attribute:: SD


   .. py:attribute:: TN


   .. py:attribute:: TX


   .. py:attribute:: UM


   .. py:attribute:: UT


   .. py:attribute:: VA


   .. py:attribute:: VI


   .. py:attribute:: VT


   .. py:attribute:: WA


   .. py:attribute:: WI


   .. py:attribute:: WV


   .. py:attribute:: WY