fortis-python-sdk 1.0.0__py3-none-any.whl

fortisapi/models/v_1_contacts_request.py

@@ -0,0 +1,685 @@
+"""fortisapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from fortisapi.api_helper import APIHelper
+from fortisapi.models.address import Address
+
+
+class V1ContactsRequest(object):
+    """Implementation of the 'V1 Contacts Request' model.
+
+    Attributes:
+        location_id (str): Location ID
+        account_number (str): Contact Account Number
+        contact_api_id (str): Contact API Id
+        first_name (str): First Name
+        last_name (str): Last Name
+        cell_phone (str): Cell phone of contact
+        balance (float): Balance
+        address (Address): Address of contact
+        company_name (str): Company Name
+        header_message (str): Header Message
+        date_of_birth (str): Contacts DOB, Format: yyyy-MM-dd
+        email_trx_receipt (bool): Whether or not to email all transactions receipts
+            to contact (1 or 0)
+        home_phone (str): Contacts home phone
+        office_phone (str): Contacts office phone
+        office_phone_ext (str): Contacts office phone extension for office phone
+        home_phone_country_code (str): Home phone country code
+        office_phone_country_code (str): Office phone country code
+        cell_phone_country_code (str): Cell phone country code
+        header_message_type (int): Header Message Type
+        update_if_exists (UpdateIfExistsEnum): Update If Exists
+        contact_c_1 (str): Custom field 1 for api users to store custom data
+        contact_c_2 (str): Custom field 2 for api users to store custom data
+        contact_c_3 (str): Custom field 3 for api users to store custom data
+        parent_id (str): Parent Id
+        email (str): Email of contact
+        token_import_id (str): Token Import Id
+        additional_properties (Dict[str, object]): The additional properties for the
+            model.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "location_id": "location_id",
+        "last_name": "last_name",
+        "account_number": "account_number",
+        "contact_api_id": "contact_api_id",
+        "first_name": "first_name",
+        "cell_phone": "cell_phone",
+        "balance": "balance",
+        "address": "address",
+        "company_name": "company_name",
+        "header_message": "header_message",
+        "date_of_birth": "date_of_birth",
+        "email_trx_receipt": "email_trx_receipt",
+        "home_phone": "home_phone",
+        "office_phone": "office_phone",
+        "office_phone_ext": "office_phone_ext",
+        "home_phone_country_code": "home_phone_country_code",
+        "office_phone_country_code": "office_phone_country_code",
+        "cell_phone_country_code": "cell_phone_country_code",
+        "header_message_type": "header_message_type",
+        "update_if_exists": "update_if_exists",
+        "contact_c_1": "contact_c1",
+        "contact_c_2": "contact_c2",
+        "contact_c_3": "contact_c3",
+        "parent_id": "parent_id",
+        "email": "email",
+        "token_import_id": "token_import_id",
+    }
+
+    _optionals = [
+        "account_number",
+        "contact_api_id",
+        "first_name",
+        "cell_phone",
+        "balance",
+        "address",
+        "company_name",
+        "header_message",
+        "date_of_birth",
+        "email_trx_receipt",
+        "home_phone",
+        "office_phone",
+        "office_phone_ext",
+        "home_phone_country_code",
+        "office_phone_country_code",
+        "cell_phone_country_code",
+        "header_message_type",
+        "update_if_exists",
+        "contact_c_1",
+        "contact_c_2",
+        "contact_c_3",
+        "parent_id",
+        "email",
+        "token_import_id",
+    ]
+
+    _nullables = [
+        "account_number",
+        "contact_api_id",
+        "first_name",
+        "cell_phone",
+        "balance",
+        "company_name",
+        "header_message",
+        "date_of_birth",
+        "home_phone",
+        "office_phone",
+        "office_phone_ext",
+        "home_phone_country_code",
+        "office_phone_country_code",
+        "cell_phone_country_code",
+        "header_message_type",
+        "update_if_exists",
+        "contact_c_1",
+        "contact_c_2",
+        "contact_c_3",
+        "parent_id",
+        "email",
+        "token_import_id",
+    ]
+
+    def __init__(
+        self,
+        location_id=None,
+        last_name=None,
+        account_number=APIHelper.SKIP,
+        contact_api_id=APIHelper.SKIP,
+        first_name=APIHelper.SKIP,
+        cell_phone=APIHelper.SKIP,
+        balance=APIHelper.SKIP,
+        address=APIHelper.SKIP,
+        company_name=APIHelper.SKIP,
+        header_message=APIHelper.SKIP,
+        date_of_birth=APIHelper.SKIP,
+        email_trx_receipt=APIHelper.SKIP,
+        home_phone=APIHelper.SKIP,
+        office_phone=APIHelper.SKIP,
+        office_phone_ext=APIHelper.SKIP,
+        home_phone_country_code=APIHelper.SKIP,
+        office_phone_country_code=APIHelper.SKIP,
+        cell_phone_country_code=APIHelper.SKIP,
+        header_message_type=APIHelper.SKIP,
+        update_if_exists=APIHelper.SKIP,
+        contact_c_1=APIHelper.SKIP,
+        contact_c_2=APIHelper.SKIP,
+        contact_c_3=APIHelper.SKIP,
+        parent_id=APIHelper.SKIP,
+        email=APIHelper.SKIP,
+        token_import_id=APIHelper.SKIP,
+        additional_properties=None):
+        """Initialize a V1ContactsRequest instance."""
+        # Initialize members of the class
+        self.location_id = location_id
+        if account_number is not APIHelper.SKIP:
+            self.account_number = account_number
+        if contact_api_id is not APIHelper.SKIP:
+            self.contact_api_id = contact_api_id
+        if first_name is not APIHelper.SKIP:
+            self.first_name = first_name
+        self.last_name = last_name
+        if cell_phone is not APIHelper.SKIP:
+            self.cell_phone = cell_phone
+        if balance is not APIHelper.SKIP:
+            self.balance = balance
+        if address is not APIHelper.SKIP:
+            self.address = address
+        if company_name is not APIHelper.SKIP:
+            self.company_name = company_name
+        if header_message is not APIHelper.SKIP:
+            self.header_message = header_message
+        if date_of_birth is not APIHelper.SKIP:
+            self.date_of_birth = date_of_birth
+        if email_trx_receipt is not APIHelper.SKIP:
+            self.email_trx_receipt = email_trx_receipt
+        if home_phone is not APIHelper.SKIP:
+            self.home_phone = home_phone
+        if office_phone is not APIHelper.SKIP:
+            self.office_phone = office_phone
+        if office_phone_ext is not APIHelper.SKIP:
+            self.office_phone_ext = office_phone_ext
+        if home_phone_country_code is not APIHelper.SKIP:
+            self.home_phone_country_code = home_phone_country_code
+        if office_phone_country_code is not APIHelper.SKIP:
+            self.office_phone_country_code = office_phone_country_code
+        if cell_phone_country_code is not APIHelper.SKIP:
+            self.cell_phone_country_code = cell_phone_country_code
+        if header_message_type is not APIHelper.SKIP:
+            self.header_message_type = header_message_type
+        if update_if_exists is not APIHelper.SKIP:
+            self.update_if_exists = update_if_exists
+        if contact_c_1 is not APIHelper.SKIP:
+            self.contact_c_1 = contact_c_1
+        if contact_c_2 is not APIHelper.SKIP:
+            self.contact_c_2 = contact_c_2
+        if contact_c_3 is not APIHelper.SKIP:
+            self.contact_c_3 = contact_c_3
+        if parent_id is not APIHelper.SKIP:
+            self.parent_id = parent_id
+        if email is not APIHelper.SKIP:
+            self.email = email
+        if token_import_id is not APIHelper.SKIP:
+            self.token_import_id = token_import_id
+
+        # Add additional model properties to the instance
+        if additional_properties is None:
+            additional_properties = {}
+        self.additional_properties = additional_properties
+
+    @classmethod
+    def from_dictionary(cls,
+                        dictionary):
+        """Create an instance of this model from a dictionary
+
+        Args:
+            dictionary (dictionary): A dictionary representation of the object
+            as obtained from the deserialization of the server's response. The
+            keys MUST match property names in the API description.
+
+        Returns:
+            object: An instance of this structure class.
+
+        """
+        if not isinstance(dictionary, dict) or dictionary is None:
+            return None
+
+        # Extract variables from the dictionary
+        location_id =\
+            dictionary.get("location_id")\
+            if dictionary.get("location_id")\
+                else None
+        last_name =\
+            dictionary.get("last_name")\
+            if dictionary.get("last_name")\
+                else None
+        account_number =\
+            dictionary.get("account_number")\
+            if "account_number" in dictionary.keys()\
+                else APIHelper.SKIP
+        contact_api_id =\
+            dictionary.get("contact_api_id")\
+            if "contact_api_id" in dictionary.keys()\
+                else APIHelper.SKIP
+        first_name =\
+            dictionary.get("first_name")\
+            if "first_name" in dictionary.keys()\
+                else APIHelper.SKIP
+        cell_phone =\
+            dictionary.get("cell_phone")\
+            if "cell_phone" in dictionary.keys()\
+                else APIHelper.SKIP
+        balance =\
+            dictionary.get("balance")\
+            if "balance" in dictionary.keys()\
+                else APIHelper.SKIP
+        address =\
+            Address.from_dictionary(
+                dictionary.get("address"))\
+                if "address" in dictionary.keys()\
+                else APIHelper.SKIP
+        company_name =\
+            dictionary.get("company_name")\
+            if "company_name" in dictionary.keys()\
+                else APIHelper.SKIP
+        header_message =\
+            dictionary.get("header_message")\
+            if "header_message" in dictionary.keys()\
+                else APIHelper.SKIP
+        date_of_birth =\
+            dictionary.get("date_of_birth")\
+            if "date_of_birth" in dictionary.keys()\
+                else APIHelper.SKIP
+        email_trx_receipt =\
+            dictionary.get("email_trx_receipt")\
+            if "email_trx_receipt" in dictionary.keys()\
+                else APIHelper.SKIP
+        home_phone =\
+            dictionary.get("home_phone")\
+            if "home_phone" in dictionary.keys()\
+                else APIHelper.SKIP
+        office_phone =\
+            dictionary.get("office_phone")\
+            if "office_phone" in dictionary.keys()\
+                else APIHelper.SKIP
+        office_phone_ext =\
+            dictionary.get("office_phone_ext")\
+            if "office_phone_ext" in dictionary.keys()\
+                else APIHelper.SKIP
+        home_phone_country_code =\
+            dictionary.get("home_phone_country_code")\
+            if "home_phone_country_code" in dictionary.keys()\
+                else APIHelper.SKIP
+        office_phone_country_code =\
+            dictionary.get("office_phone_country_code")\
+            if "office_phone_country_code" in dictionary.keys()\
+                else APIHelper.SKIP
+        cell_phone_country_code =\
+            dictionary.get("cell_phone_country_code")\
+            if "cell_phone_country_code" in dictionary.keys()\
+                else APIHelper.SKIP
+        header_message_type =\
+            dictionary.get("header_message_type")\
+            if "header_message_type" in dictionary.keys()\
+                else APIHelper.SKIP
+        update_if_exists =\
+            dictionary.get("update_if_exists")\
+            if "update_if_exists" in dictionary.keys()\
+                else APIHelper.SKIP
+        contact_c_1 =\
+            dictionary.get("contact_c1")\
+            if "contact_c1" in dictionary.keys()\
+                else APIHelper.SKIP
+        contact_c_2 =\
+            dictionary.get("contact_c2")\
+            if "contact_c2" in dictionary.keys()\
+                else APIHelper.SKIP
+        contact_c_3 =\
+            dictionary.get("contact_c3")\
+            if "contact_c3" in dictionary.keys()\
+                else APIHelper.SKIP
+        parent_id =\
+            dictionary.get("parent_id")\
+            if "parent_id" in dictionary.keys()\
+                else APIHelper.SKIP
+        email =\
+            dictionary.get("email")\
+            if "email" in dictionary.keys()\
+                else APIHelper.SKIP
+        token_import_id =\
+            dictionary.get("token_import_id")\
+            if "token_import_id" in dictionary.keys()\
+                else APIHelper.SKIP
+
+        # Clean out expected properties from dictionary
+        additional_properties =\
+            {k: v for k, v in dictionary.items() if k not in cls._names.values()}
+
+        # Return an object of this model
+        return cls(location_id,
+                   last_name,
+                   account_number,
+                   contact_api_id,
+                   first_name,
+                   cell_phone,
+                   balance,
+                   address,
+                   company_name,
+                   header_message,
+                   date_of_birth,
+                   email_trx_receipt,
+                   home_phone,
+                   office_phone,
+                   office_phone_ext,
+                   home_phone_country_code,
+                   office_phone_country_code,
+                   cell_phone_country_code,
+                   header_message_type,
+                   update_if_exists,
+                   contact_c_1,
+                   contact_c_2,
+                   contact_c_3,
+                   parent_id,
+                   email,
+                   token_import_id,
+                   additional_properties)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _location_id=self.location_id
+        _account_number=(
+            self.account_number
+            if hasattr(self, "account_number")
+            else None
+        )
+        _contact_api_id=(
+            self.contact_api_id
+            if hasattr(self, "contact_api_id")
+            else None
+        )
+        _first_name=(
+            self.first_name
+            if hasattr(self, "first_name")
+            else None
+        )
+        _last_name=self.last_name
+        _cell_phone=(
+            self.cell_phone
+            if hasattr(self, "cell_phone")
+            else None
+        )
+        _balance=(
+            self.balance
+            if hasattr(self, "balance")
+            else None
+        )
+        _address=(
+            self.address
+            if hasattr(self, "address")
+            else None
+        )
+        _company_name=(
+            self.company_name
+            if hasattr(self, "company_name")
+            else None
+        )
+        _header_message=(
+            self.header_message
+            if hasattr(self, "header_message")
+            else None
+        )
+        _date_of_birth=(
+            self.date_of_birth
+            if hasattr(self, "date_of_birth")
+            else None
+        )
+        _email_trx_receipt=(
+            self.email_trx_receipt
+            if hasattr(self, "email_trx_receipt")
+            else None
+        )
+        _home_phone=(
+            self.home_phone
+            if hasattr(self, "home_phone")
+            else None
+        )
+        _office_phone=(
+            self.office_phone
+            if hasattr(self, "office_phone")
+            else None
+        )
+        _office_phone_ext=(
+            self.office_phone_ext
+            if hasattr(self, "office_phone_ext")
+            else None
+        )
+        _home_phone_country_code=(
+            self.home_phone_country_code
+            if hasattr(self, "home_phone_country_code")
+            else None
+        )
+        _office_phone_country_code=(
+            self.office_phone_country_code
+            if hasattr(self, "office_phone_country_code")
+            else None
+        )
+        _cell_phone_country_code=(
+            self.cell_phone_country_code
+            if hasattr(self, "cell_phone_country_code")
+            else None
+        )
+        _header_message_type=(
+            self.header_message_type
+            if hasattr(self, "header_message_type")
+            else None
+        )
+        _update_if_exists=(
+            self.update_if_exists
+            if hasattr(self, "update_if_exists")
+            else None
+        )
+        _contact_c_1=(
+            self.contact_c_1
+            if hasattr(self, "contact_c_1")
+            else None
+        )
+        _contact_c_2=(
+            self.contact_c_2
+            if hasattr(self, "contact_c_2")
+            else None
+        )
+        _contact_c_3=(
+            self.contact_c_3
+            if hasattr(self, "contact_c_3")
+            else None
+        )
+        _parent_id=(
+            self.parent_id
+            if hasattr(self, "parent_id")
+            else None
+        )
+        _email=(
+            self.email
+            if hasattr(self, "email")
+            else None
+        )
+        _token_import_id=(
+            self.token_import_id
+            if hasattr(self, "token_import_id")
+            else None
+        )
+        _additional_properties=self.additional_properties
+        return (
+            f"{self.__class__.__name__}("
+            f"location_id={_location_id!r}, "
+            f"account_number={_account_number!r}, "
+            f"contact_api_id={_contact_api_id!r}, "
+            f"first_name={_first_name!r}, "
+            f"last_name={_last_name!r}, "
+            f"cell_phone={_cell_phone!r}, "
+            f"balance={_balance!r}, "
+            f"address={_address!r}, "
+            f"company_name={_company_name!r}, "
+            f"header_message={_header_message!r}, "
+            f"date_of_birth={_date_of_birth!r}, "
+            f"email_trx_receipt={_email_trx_receipt!r}, "
+            f"home_phone={_home_phone!r}, "
+            f"office_phone={_office_phone!r}, "
+            f"office_phone_ext={_office_phone_ext!r}, "
+            f"home_phone_country_code={_home_phone_country_code!r}, "
+            f"office_phone_country_code={_office_phone_country_code!r}, "
+            f"cell_phone_country_code={_cell_phone_country_code!r}, "
+            f"header_message_type={_header_message_type!r}, "
+            f"update_if_exists={_update_if_exists!r}, "
+            f"contact_c_1={_contact_c_1!r}, "
+            f"contact_c_2={_contact_c_2!r}, "
+            f"contact_c_3={_contact_c_3!r}, "
+            f"parent_id={_parent_id!r}, "
+            f"email={_email!r}, "
+            f"token_import_id={_token_import_id!r}, "
+            f"additional_properties={_additional_properties!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _location_id=self.location_id
+        _account_number=(
+            self.account_number
+            if hasattr(self, "account_number")
+            else None
+        )
+        _contact_api_id=(
+            self.contact_api_id
+            if hasattr(self, "contact_api_id")
+            else None
+        )
+        _first_name=(
+            self.first_name
+            if hasattr(self, "first_name")
+            else None
+        )
+        _last_name=self.last_name
+        _cell_phone=(
+            self.cell_phone
+            if hasattr(self, "cell_phone")
+            else None
+        )
+        _balance=(
+            self.balance
+            if hasattr(self, "balance")
+            else None
+        )
+        _address=(
+            self.address
+            if hasattr(self, "address")
+            else None
+        )
+        _company_name=(
+            self.company_name
+            if hasattr(self, "company_name")
+            else None
+        )
+        _header_message=(
+            self.header_message
+            if hasattr(self, "header_message")
+            else None
+        )
+        _date_of_birth=(
+            self.date_of_birth
+            if hasattr(self, "date_of_birth")
+            else None
+        )
+        _email_trx_receipt=(
+            self.email_trx_receipt
+            if hasattr(self, "email_trx_receipt")
+            else None
+        )
+        _home_phone=(
+            self.home_phone
+            if hasattr(self, "home_phone")
+            else None
+        )
+        _office_phone=(
+            self.office_phone
+            if hasattr(self, "office_phone")
+            else None
+        )
+        _office_phone_ext=(
+            self.office_phone_ext
+            if hasattr(self, "office_phone_ext")
+            else None
+        )
+        _home_phone_country_code=(
+            self.home_phone_country_code
+            if hasattr(self, "home_phone_country_code")
+            else None
+        )
+        _office_phone_country_code=(
+            self.office_phone_country_code
+            if hasattr(self, "office_phone_country_code")
+            else None
+        )
+        _cell_phone_country_code=(
+            self.cell_phone_country_code
+            if hasattr(self, "cell_phone_country_code")
+            else None
+        )
+        _header_message_type=(
+            self.header_message_type
+            if hasattr(self, "header_message_type")
+            else None
+        )
+        _update_if_exists=(
+            self.update_if_exists
+            if hasattr(self, "update_if_exists")
+            else None
+        )
+        _contact_c_1=(
+            self.contact_c_1
+            if hasattr(self, "contact_c_1")
+            else None
+        )
+        _contact_c_2=(
+            self.contact_c_2
+            if hasattr(self, "contact_c_2")
+            else None
+        )
+        _contact_c_3=(
+            self.contact_c_3
+            if hasattr(self, "contact_c_3")
+            else None
+        )
+        _parent_id=(
+            self.parent_id
+            if hasattr(self, "parent_id")
+            else None
+        )
+        _email=(
+            self.email
+            if hasattr(self, "email")
+            else None
+        )
+        _token_import_id=(
+            self.token_import_id
+            if hasattr(self, "token_import_id")
+            else None
+        )
+        _additional_properties=self.additional_properties
+        return (
+            f"{self.__class__.__name__}("
+            f"location_id={_location_id!s}, "
+            f"account_number={_account_number!s}, "
+            f"contact_api_id={_contact_api_id!s}, "
+            f"first_name={_first_name!s}, "
+            f"last_name={_last_name!s}, "
+            f"cell_phone={_cell_phone!s}, "
+            f"balance={_balance!s}, "
+            f"address={_address!s}, "
+            f"company_name={_company_name!s}, "
+            f"header_message={_header_message!s}, "
+            f"date_of_birth={_date_of_birth!s}, "
+            f"email_trx_receipt={_email_trx_receipt!s}, "
+            f"home_phone={_home_phone!s}, "
+            f"office_phone={_office_phone!s}, "
+            f"office_phone_ext={_office_phone_ext!s}, "
+            f"home_phone_country_code={_home_phone_country_code!s}, "
+            f"office_phone_country_code={_office_phone_country_code!s}, "
+            f"cell_phone_country_code={_cell_phone_country_code!s}, "
+            f"header_message_type={_header_message_type!s}, "
+            f"update_if_exists={_update_if_exists!s}, "
+            f"contact_c_1={_contact_c_1!s}, "
+            f"contact_c_2={_contact_c_2!s}, "
+            f"contact_c_3={_contact_c_3!s}, "
+            f"parent_id={_parent_id!s}, "
+            f"email={_email!s}, "
+            f"token_import_id={_token_import_id!s}, "
+            f"additional_properties={_additional_properties!s}, "
+            f")"
+        )