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

fortisapi/models/v_1_recurrings_request.py

@@ -0,0 +1,742 @@
+"""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.joi import Joi
+
+
+class V1RecurringsRequest(object):
+    """Implementation of the 'V1 Recurrings Request' model.
+
+    Attributes:
+        account_vault_id (str): Token ID
+        token_id (str): Token ID
+        contact_id (str): Contact ID
+        account_vault_api_id (str): Token API ID
+        token_api_id (str): Token API ID
+        joi (Joi): The model property of type Joi.
+        active (bool): Active
+        description (str): Description
+        end_date (str): End date
+        installment_total_count (int): Installment Total Count
+        interval (int): Interval
+        interval_type (IntervalTypeEnum): Interval Type
+        location_id (str): Location ID
+        notification_days (int): Notification Days
+        payment_method (PaymentMethod1Enum): Payment Method
+        product_transaction_id (str): Product Transaction ID
+        recurring_id (str): Recurring ID
+        recurring_api_id (str): Recurring Api ID
+        start_date (str): Start date
+        status (StatusEnum): Status
+        transaction_amount (int): Transaction amount
+        terms_agree (bool): Terms Agree
+        terms_agree_ip (str): Terms Agree Ip
+        recurring_c_1 (str): Custom field used for integrations
+        recurring_c_2 (str): Custom field used for integrations
+        recurring_c_3 (str): Custom field used for integrations
+        send_to_proc_as_recur (bool): Send To Proc As Recur
+        tags (List[str]): Tags
+        secondary_amount (int): Retained Amount
+        bill_payment (bool): Bill Payment
+        additional_properties (Dict[str, object]): The additional properties for the
+            model.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "interval": "interval",
+        "interval_type": "interval_type",
+        "location_id": "location_id",
+        "start_date": "start_date",
+        "transaction_amount": "transaction_amount",
+        "account_vault_id": "account_vault_id",
+        "token_id": "token_id",
+        "contact_id": "contact_id",
+        "account_vault_api_id": "account_vault_api_id",
+        "token_api_id": "token_api_id",
+        "joi": "_joi",
+        "active": "active",
+        "description": "description",
+        "end_date": "end_date",
+        "installment_total_count": "installment_total_count",
+        "notification_days": "notification_days",
+        "payment_method": "payment_method",
+        "product_transaction_id": "product_transaction_id",
+        "recurring_id": "recurring_id",
+        "recurring_api_id": "recurring_api_id",
+        "status": "status",
+        "terms_agree": "terms_agree",
+        "terms_agree_ip": "terms_agree_ip",
+        "recurring_c_1": "recurring_c1",
+        "recurring_c_2": "recurring_c2",
+        "recurring_c_3": "recurring_c3",
+        "send_to_proc_as_recur": "send_to_proc_as_recur",
+        "tags": "tags",
+        "secondary_amount": "secondary_amount",
+        "bill_payment": "bill_payment",
+    }
+
+    _optionals = [
+        "account_vault_id",
+        "token_id",
+        "contact_id",
+        "account_vault_api_id",
+        "token_api_id",
+        "joi",
+        "active",
+        "description",
+        "end_date",
+        "installment_total_count",
+        "notification_days",
+        "payment_method",
+        "product_transaction_id",
+        "recurring_id",
+        "recurring_api_id",
+        "status",
+        "terms_agree",
+        "terms_agree_ip",
+        "recurring_c_1",
+        "recurring_c_2",
+        "recurring_c_3",
+        "send_to_proc_as_recur",
+        "tags",
+        "secondary_amount",
+        "bill_payment",
+    ]
+
+    _nullables = [
+        "contact_id",
+        "account_vault_api_id",
+        "token_api_id",
+        "description",
+        "end_date",
+        "installment_total_count",
+        "notification_days",
+        "payment_method",
+        "product_transaction_id",
+        "recurring_id",
+        "recurring_api_id",
+        "status",
+        "terms_agree_ip",
+        "recurring_c_1",
+        "recurring_c_2",
+        "recurring_c_3",
+        "tags",
+        "secondary_amount",
+    ]
+
+    def __init__(
+        self,
+        interval=None,
+        interval_type=None,
+        location_id=None,
+        start_date=None,
+        transaction_amount=None,
+        account_vault_id=APIHelper.SKIP,
+        token_id=APIHelper.SKIP,
+        contact_id=APIHelper.SKIP,
+        account_vault_api_id=APIHelper.SKIP,
+        token_api_id=APIHelper.SKIP,
+        joi=APIHelper.SKIP,
+        active=APIHelper.SKIP,
+        description=APIHelper.SKIP,
+        end_date=APIHelper.SKIP,
+        installment_total_count=APIHelper.SKIP,
+        notification_days=APIHelper.SKIP,
+        payment_method=APIHelper.SKIP,
+        product_transaction_id=APIHelper.SKIP,
+        recurring_id=APIHelper.SKIP,
+        recurring_api_id=APIHelper.SKIP,
+        status=APIHelper.SKIP,
+        terms_agree=APIHelper.SKIP,
+        terms_agree_ip=APIHelper.SKIP,
+        recurring_c_1=APIHelper.SKIP,
+        recurring_c_2=APIHelper.SKIP,
+        recurring_c_3=APIHelper.SKIP,
+        send_to_proc_as_recur=APIHelper.SKIP,
+        tags=APIHelper.SKIP,
+        secondary_amount=APIHelper.SKIP,
+        bill_payment=APIHelper.SKIP,
+        additional_properties=None):
+        """Initialize a V1RecurringsRequest instance."""
+        # Initialize members of the class
+        if account_vault_id is not APIHelper.SKIP:
+            self.account_vault_id = account_vault_id
+        if token_id is not APIHelper.SKIP:
+            self.token_id = token_id
+        if contact_id is not APIHelper.SKIP:
+            self.contact_id = contact_id
+        if account_vault_api_id is not APIHelper.SKIP:
+            self.account_vault_api_id = account_vault_api_id
+        if token_api_id is not APIHelper.SKIP:
+            self.token_api_id = token_api_id
+        if joi is not APIHelper.SKIP:
+            self.joi = joi
+        if active is not APIHelper.SKIP:
+            self.active = active
+        if description is not APIHelper.SKIP:
+            self.description = description
+        if end_date is not APIHelper.SKIP:
+            self.end_date = end_date
+        if installment_total_count is not APIHelper.SKIP:
+            self.installment_total_count = installment_total_count
+        self.interval = interval
+        self.interval_type = interval_type
+        self.location_id = location_id
+        if notification_days is not APIHelper.SKIP:
+            self.notification_days = notification_days
+        if payment_method is not APIHelper.SKIP:
+            self.payment_method = payment_method
+        if product_transaction_id is not APIHelper.SKIP:
+            self.product_transaction_id = product_transaction_id
+        if recurring_id is not APIHelper.SKIP:
+            self.recurring_id = recurring_id
+        if recurring_api_id is not APIHelper.SKIP:
+            self.recurring_api_id = recurring_api_id
+        self.start_date = start_date
+        if status is not APIHelper.SKIP:
+            self.status = status
+        self.transaction_amount = transaction_amount
+        if terms_agree is not APIHelper.SKIP:
+            self.terms_agree = terms_agree
+        if terms_agree_ip is not APIHelper.SKIP:
+            self.terms_agree_ip = terms_agree_ip
+        if recurring_c_1 is not APIHelper.SKIP:
+            self.recurring_c_1 = recurring_c_1
+        if recurring_c_2 is not APIHelper.SKIP:
+            self.recurring_c_2 = recurring_c_2
+        if recurring_c_3 is not APIHelper.SKIP:
+            self.recurring_c_3 = recurring_c_3
+        if send_to_proc_as_recur is not APIHelper.SKIP:
+            self.send_to_proc_as_recur = send_to_proc_as_recur
+        if tags is not APIHelper.SKIP:
+            self.tags = tags
+        if secondary_amount is not APIHelper.SKIP:
+            self.secondary_amount = secondary_amount
+        if bill_payment is not APIHelper.SKIP:
+            self.bill_payment = bill_payment
+
+        # 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
+        interval =\
+            dictionary.get("interval")\
+            if dictionary.get("interval")\
+                else None
+        interval_type =\
+            dictionary.get("interval_type")\
+            if dictionary.get("interval_type")\
+                else None
+        location_id =\
+            dictionary.get("location_id")\
+            if dictionary.get("location_id")\
+                else None
+        start_date =\
+            dictionary.get("start_date")\
+            if dictionary.get("start_date")\
+                else None
+        transaction_amount =\
+            dictionary.get("transaction_amount")\
+            if dictionary.get("transaction_amount")\
+                else None
+        account_vault_id =\
+            dictionary.get("account_vault_id")\
+            if dictionary.get("account_vault_id")\
+                else APIHelper.SKIP
+        token_id =\
+            dictionary.get("token_id")\
+            if dictionary.get("token_id")\
+                else APIHelper.SKIP
+        contact_id =\
+            dictionary.get("contact_id")\
+            if "contact_id" in dictionary.keys()\
+                else APIHelper.SKIP
+        account_vault_api_id =\
+            dictionary.get("account_vault_api_id")\
+            if "account_vault_api_id" in dictionary.keys()\
+                else APIHelper.SKIP
+        token_api_id =\
+            dictionary.get("token_api_id")\
+            if "token_api_id" in dictionary.keys()\
+                else APIHelper.SKIP
+        joi =\
+            Joi.from_dictionary(
+                dictionary.get("_joi"))\
+                if "_joi" in dictionary.keys()\
+                else APIHelper.SKIP
+        active =\
+            dictionary.get("active")\
+            if "active" in dictionary.keys()\
+                else APIHelper.SKIP
+        description =\
+            dictionary.get("description")\
+            if "description" in dictionary.keys()\
+                else APIHelper.SKIP
+        end_date =\
+            dictionary.get("end_date")\
+            if "end_date" in dictionary.keys()\
+                else APIHelper.SKIP
+        installment_total_count =\
+            dictionary.get("installment_total_count")\
+            if "installment_total_count" in dictionary.keys()\
+                else APIHelper.SKIP
+        notification_days =\
+            dictionary.get("notification_days")\
+            if "notification_days" in dictionary.keys()\
+                else APIHelper.SKIP
+        payment_method =\
+            dictionary.get("payment_method")\
+            if "payment_method" in dictionary.keys()\
+                else APIHelper.SKIP
+        product_transaction_id =\
+            dictionary.get("product_transaction_id")\
+            if "product_transaction_id" in dictionary.keys()\
+                else APIHelper.SKIP
+        recurring_id =\
+            dictionary.get("recurring_id")\
+            if "recurring_id" in dictionary.keys()\
+                else APIHelper.SKIP
+        recurring_api_id =\
+            dictionary.get("recurring_api_id")\
+            if "recurring_api_id" in dictionary.keys()\
+                else APIHelper.SKIP
+        status =\
+            dictionary.get("status")\
+            if "status" in dictionary.keys()\
+                else APIHelper.SKIP
+        terms_agree =\
+            dictionary.get("terms_agree")\
+            if "terms_agree" in dictionary.keys()\
+                else APIHelper.SKIP
+        terms_agree_ip =\
+            dictionary.get("terms_agree_ip")\
+            if "terms_agree_ip" in dictionary.keys()\
+                else APIHelper.SKIP
+        recurring_c_1 =\
+            dictionary.get("recurring_c1")\
+            if "recurring_c1" in dictionary.keys()\
+                else APIHelper.SKIP
+        recurring_c_2 =\
+            dictionary.get("recurring_c2")\
+            if "recurring_c2" in dictionary.keys()\
+                else APIHelper.SKIP
+        recurring_c_3 =\
+            dictionary.get("recurring_c3")\
+            if "recurring_c3" in dictionary.keys()\
+                else APIHelper.SKIP
+        send_to_proc_as_recur =\
+            dictionary.get("send_to_proc_as_recur")\
+            if "send_to_proc_as_recur" in dictionary.keys()\
+                else APIHelper.SKIP
+        tags =\
+            dictionary.get("tags")\
+            if "tags" in dictionary.keys()\
+                else APIHelper.SKIP
+        secondary_amount =\
+            dictionary.get("secondary_amount")\
+            if "secondary_amount" in dictionary.keys()\
+                else APIHelper.SKIP
+        bill_payment =\
+            dictionary.get("bill_payment")\
+            if "bill_payment" 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(interval,
+                   interval_type,
+                   location_id,
+                   start_date,
+                   transaction_amount,
+                   account_vault_id,
+                   token_id,
+                   contact_id,
+                   account_vault_api_id,
+                   token_api_id,
+                   joi,
+                   active,
+                   description,
+                   end_date,
+                   installment_total_count,
+                   notification_days,
+                   payment_method,
+                   product_transaction_id,
+                   recurring_id,
+                   recurring_api_id,
+                   status,
+                   terms_agree,
+                   terms_agree_ip,
+                   recurring_c_1,
+                   recurring_c_2,
+                   recurring_c_3,
+                   send_to_proc_as_recur,
+                   tags,
+                   secondary_amount,
+                   bill_payment,
+                   additional_properties)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _account_vault_id=(
+            self.account_vault_id
+            if hasattr(self, "account_vault_id")
+            else None
+        )
+        _token_id=(
+            self.token_id
+            if hasattr(self, "token_id")
+            else None
+        )
+        _contact_id=(
+            self.contact_id
+            if hasattr(self, "contact_id")
+            else None
+        )
+        _account_vault_api_id=(
+            self.account_vault_api_id
+            if hasattr(self, "account_vault_api_id")
+            else None
+        )
+        _token_api_id=(
+            self.token_api_id
+            if hasattr(self, "token_api_id")
+            else None
+        )
+        _joi=(
+            self.joi
+            if hasattr(self, "joi")
+            else None
+        )
+        _active=(
+            self.active
+            if hasattr(self, "active")
+            else None
+        )
+        _description=(
+            self.description
+            if hasattr(self, "description")
+            else None
+        )
+        _end_date=(
+            self.end_date
+            if hasattr(self, "end_date")
+            else None
+        )
+        _installment_total_count=(
+            self.installment_total_count
+            if hasattr(self, "installment_total_count")
+            else None
+        )
+        _interval=self.interval
+        _interval_type=self.interval_type
+        _location_id=self.location_id
+        _notification_days=(
+            self.notification_days
+            if hasattr(self, "notification_days")
+            else None
+        )
+        _payment_method=(
+            self.payment_method
+            if hasattr(self, "payment_method")
+            else None
+        )
+        _product_transaction_id=(
+            self.product_transaction_id
+            if hasattr(self, "product_transaction_id")
+            else None
+        )
+        _recurring_id=(
+            self.recurring_id
+            if hasattr(self, "recurring_id")
+            else None
+        )
+        _recurring_api_id=(
+            self.recurring_api_id
+            if hasattr(self, "recurring_api_id")
+            else None
+        )
+        _start_date=self.start_date
+        _status=(
+            self.status
+            if hasattr(self, "status")
+            else None
+        )
+        _transaction_amount=self.transaction_amount
+        _terms_agree=(
+            self.terms_agree
+            if hasattr(self, "terms_agree")
+            else None
+        )
+        _terms_agree_ip=(
+            self.terms_agree_ip
+            if hasattr(self, "terms_agree_ip")
+            else None
+        )
+        _recurring_c_1=(
+            self.recurring_c_1
+            if hasattr(self, "recurring_c_1")
+            else None
+        )
+        _recurring_c_2=(
+            self.recurring_c_2
+            if hasattr(self, "recurring_c_2")
+            else None
+        )
+        _recurring_c_3=(
+            self.recurring_c_3
+            if hasattr(self, "recurring_c_3")
+            else None
+        )
+        _send_to_proc_as_recur=(
+            self.send_to_proc_as_recur
+            if hasattr(self, "send_to_proc_as_recur")
+            else None
+        )
+        _tags=(
+            self.tags
+            if hasattr(self, "tags")
+            else None
+        )
+        _secondary_amount=(
+            self.secondary_amount
+            if hasattr(self, "secondary_amount")
+            else None
+        )
+        _bill_payment=(
+            self.bill_payment
+            if hasattr(self, "bill_payment")
+            else None
+        )
+        _additional_properties=self.additional_properties
+        return (
+            f"{self.__class__.__name__}("
+            f"account_vault_id={_account_vault_id!r}, "
+            f"token_id={_token_id!r}, "
+            f"contact_id={_contact_id!r}, "
+            f"account_vault_api_id={_account_vault_api_id!r}, "
+            f"token_api_id={_token_api_id!r}, "
+            f"joi={_joi!r}, "
+            f"active={_active!r}, "
+            f"description={_description!r}, "
+            f"end_date={_end_date!r}, "
+            f"installment_total_count={_installment_total_count!r}, "
+            f"interval={_interval!r}, "
+            f"interval_type={_interval_type!r}, "
+            f"location_id={_location_id!r}, "
+            f"notification_days={_notification_days!r}, "
+            f"payment_method={_payment_method!r}, "
+            f"product_transaction_id={_product_transaction_id!r}, "
+            f"recurring_id={_recurring_id!r}, "
+            f"recurring_api_id={_recurring_api_id!r}, "
+            f"start_date={_start_date!r}, "
+            f"status={_status!r}, "
+            f"transaction_amount={_transaction_amount!r}, "
+            f"terms_agree={_terms_agree!r}, "
+            f"terms_agree_ip={_terms_agree_ip!r}, "
+            f"recurring_c_1={_recurring_c_1!r}, "
+            f"recurring_c_2={_recurring_c_2!r}, "
+            f"recurring_c_3={_recurring_c_3!r}, "
+            f"send_to_proc_as_recur={_send_to_proc_as_recur!r}, "
+            f"tags={_tags!r}, "
+            f"secondary_amount={_secondary_amount!r}, "
+            f"bill_payment={_bill_payment!r}, "
+            f"additional_properties={_additional_properties!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _account_vault_id=(
+            self.account_vault_id
+            if hasattr(self, "account_vault_id")
+            else None
+        )
+        _token_id=(
+            self.token_id
+            if hasattr(self, "token_id")
+            else None
+        )
+        _contact_id=(
+            self.contact_id
+            if hasattr(self, "contact_id")
+            else None
+        )
+        _account_vault_api_id=(
+            self.account_vault_api_id
+            if hasattr(self, "account_vault_api_id")
+            else None
+        )
+        _token_api_id=(
+            self.token_api_id
+            if hasattr(self, "token_api_id")
+            else None
+        )
+        _joi=(
+            self.joi
+            if hasattr(self, "joi")
+            else None
+        )
+        _active=(
+            self.active
+            if hasattr(self, "active")
+            else None
+        )
+        _description=(
+            self.description
+            if hasattr(self, "description")
+            else None
+        )
+        _end_date=(
+            self.end_date
+            if hasattr(self, "end_date")
+            else None
+        )
+        _installment_total_count=(
+            self.installment_total_count
+            if hasattr(self, "installment_total_count")
+            else None
+        )
+        _interval=self.interval
+        _interval_type=self.interval_type
+        _location_id=self.location_id
+        _notification_days=(
+            self.notification_days
+            if hasattr(self, "notification_days")
+            else None
+        )
+        _payment_method=(
+            self.payment_method
+            if hasattr(self, "payment_method")
+            else None
+        )
+        _product_transaction_id=(
+            self.product_transaction_id
+            if hasattr(self, "product_transaction_id")
+            else None
+        )
+        _recurring_id=(
+            self.recurring_id
+            if hasattr(self, "recurring_id")
+            else None
+        )
+        _recurring_api_id=(
+            self.recurring_api_id
+            if hasattr(self, "recurring_api_id")
+            else None
+        )
+        _start_date=self.start_date
+        _status=(
+            self.status
+            if hasattr(self, "status")
+            else None
+        )
+        _transaction_amount=self.transaction_amount
+        _terms_agree=(
+            self.terms_agree
+            if hasattr(self, "terms_agree")
+            else None
+        )
+        _terms_agree_ip=(
+            self.terms_agree_ip
+            if hasattr(self, "terms_agree_ip")
+            else None
+        )
+        _recurring_c_1=(
+            self.recurring_c_1
+            if hasattr(self, "recurring_c_1")
+            else None
+        )
+        _recurring_c_2=(
+            self.recurring_c_2
+            if hasattr(self, "recurring_c_2")
+            else None
+        )
+        _recurring_c_3=(
+            self.recurring_c_3
+            if hasattr(self, "recurring_c_3")
+            else None
+        )
+        _send_to_proc_as_recur=(
+            self.send_to_proc_as_recur
+            if hasattr(self, "send_to_proc_as_recur")
+            else None
+        )
+        _tags=(
+            self.tags
+            if hasattr(self, "tags")
+            else None
+        )
+        _secondary_amount=(
+            self.secondary_amount
+            if hasattr(self, "secondary_amount")
+            else None
+        )
+        _bill_payment=(
+            self.bill_payment
+            if hasattr(self, "bill_payment")
+            else None
+        )
+        _additional_properties=self.additional_properties
+        return (
+            f"{self.__class__.__name__}("
+            f"account_vault_id={_account_vault_id!s}, "
+            f"token_id={_token_id!s}, "
+            f"contact_id={_contact_id!s}, "
+            f"account_vault_api_id={_account_vault_api_id!s}, "
+            f"token_api_id={_token_api_id!s}, "
+            f"joi={_joi!s}, "
+            f"active={_active!s}, "
+            f"description={_description!s}, "
+            f"end_date={_end_date!s}, "
+            f"installment_total_count={_installment_total_count!s}, "
+            f"interval={_interval!s}, "
+            f"interval_type={_interval_type!s}, "
+            f"location_id={_location_id!s}, "
+            f"notification_days={_notification_days!s}, "
+            f"payment_method={_payment_method!s}, "
+            f"product_transaction_id={_product_transaction_id!s}, "
+            f"recurring_id={_recurring_id!s}, "
+            f"recurring_api_id={_recurring_api_id!s}, "
+            f"start_date={_start_date!s}, "
+            f"status={_status!s}, "
+            f"transaction_amount={_transaction_amount!s}, "
+            f"terms_agree={_terms_agree!s}, "
+            f"terms_agree_ip={_terms_agree_ip!s}, "
+            f"recurring_c_1={_recurring_c_1!s}, "
+            f"recurring_c_2={_recurring_c_2!s}, "
+            f"recurring_c_3={_recurring_c_3!s}, "
+            f"send_to_proc_as_recur={_send_to_proc_as_recur!s}, "
+            f"tags={_tags!s}, "
+            f"secondary_amount={_secondary_amount!s}, "
+            f"bill_payment={_bill_payment!s}, "
+            f"additional_properties={_additional_properties!s}, "
+            f")"
+        )