# coding: utf-8

"""
    Zuora API Reference

    REST API reference for the Zuora Billing, Payments, and Central Platform! Check out the [REST API Overview](https://www.zuora.com/developer/api-references/api/overview/).

    The version of the OpenAPI document: 2024-05-20
    Contact: docs@zuora.com
    Generated by OpenAPI Generator (https://openapi-generator.tech)

    Do not edit the class manually.
"""  # noqa: E501


from __future__ import annotations
import pprint
import re  # noqa: F401
import json

from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr
from typing import Any, ClassVar, Dict, List, Optional
from zuora_sdk.models.failed_reason import FailedReason
from zuora_sdk.models.organization_label import OrganizationLabel
from zuora_sdk.models.payment_run_status import PaymentRunStatus
from typing import Optional, Set
from typing_extensions import Self

class PaymentRunResponse(BaseModel):
    """
    PaymentRunResponse
    """ # noqa: E501
    # avoid validation
    def __init__(self, **kwargs):
        # Directly assign values without validation using `construct()`
        model = self.construct(**kwargs)
        self.__dict__.update(model.__dict__)

        _dict_all = convert_snake_dict_to_camel(kwargs, self.model_fields, self.__properties)

        _dict = self.to_alias_dict(_dict_all)
        for field_name, field_info in self.model_fields.items():
            alias = field_info.alias or field_name
            if alias in _dict:
                self.__dict__[field_name] = _dict.get(alias)
        self.update_additional_properties(self, _dict_all)
        pass

    def __setattr__(self, name, value):
        # Override setattr to bypass validation when setting attributes
        object.__setattr__(self, name, value)

    account_id: Optional[StrictStr] = Field(default=None, description="The ID of the customer account associated with the payment run. ", alias="accountId")
    apply_credit_balance: Optional[StrictBool] = Field(default=None, description="**Note:** This field is only available if you have the Credit Balance feature enabled and the Invoice Settlement feature disabled.  Whether to apply credit balances in the payment run. This field is only available when you have Invoice Settlement feature disabled. ", alias="applyCreditBalance")
    auto_apply_credit_memo: Optional[StrictBool] = Field(default=None, description="**Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.  Whether to automatically apply a posted credit memo to one or more receivables in the payment run. ", alias="autoApplyCreditMemo")
    auto_apply_unapplied_payment: Optional[StrictBool] = Field(default=None, description="**Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.  Whether to automatically apply unapplied payments to  one or more receivables in the payment run. ", alias="autoApplyUnappliedPayment")
    batch: Optional[StrictStr] = Field(default=None, description="The alias name given to a batch. ")
    bill_cycle_day: Optional[StrictStr] = Field(default=None, description="The billing cycle day (BCD), the day of the month when a bill run generates invoices for the account.  ", alias="billCycleDay")
    billing_run_id: Optional[StrictStr] = Field(default=None, description="The ID of the bill run. ", alias="billingRunId")
    collect_payment: Optional[StrictBool] = Field(default=None, description="Whether to process electronic payments during the execution of payment runs.  ", alias="collectPayment")
    completed_on: Optional[StrictStr] = Field(default=None, description="The date and time when the payment run is completed, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 11:39:58. ", alias="completedOn")
    consolidated_payment: Optional[StrictBool] = Field(default=None, description="**Note:** The **Process Electronic Payment** permission also needs to be allowed for a Manage Payment Runs role to work. See [Payments Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/e_Payments_Roles) for more information.   Whether to process a single payment for all receivables that are due on an account. ", alias="consolidatedPayment")
    created_by_id: Optional[StrictStr] = Field(default=None, description="The ID of the Zuora user who created the payment run. ", alias="createdById")
    created_date: Optional[StrictStr] = Field(default=None, description="The date and time when the payment run was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10. ", alias="createdDate")
    currency: Optional[StrictStr] = Field(default=None, description="A currency defined in the web-based UI administrative settings. ")
    executed_on: Optional[StrictStr] = Field(default=None, description="The date and time when the payment run is executed, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 11:30:37. ", alias="executedOn")
    id: Optional[StrictStr] = Field(default=None, description="The ID of the payment run. ")
    number: Optional[StrictStr] = Field(default=None, description="The identification number of the payment run. ")
    payment_gateway_id: Optional[StrictStr] = Field(default=None, description="The ID of the gateway instance that processes the payment. ", alias="paymentGatewayId")
    process_payment_with_closed_pm: Optional[StrictBool] = Field(default=None, description="**Note:** The **Process Electronic Payment** permission also needs to be allowed for a Manage Payment Runs role to work. See [Payments Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/e_Payments_Roles) for more information.   Whether to process payments even if the default payment method is closed. ", alias="processPaymentWithClosedPM")
    run_date: Optional[StrictStr] = Field(default=None, description="The date and time when the scheduled payment run is to be executed for collecting payments. ", alias="runDate")
    payment_gateway_number: Optional[StrictStr] = Field(default=None, alias="paymentGatewayNumber")
    status: Optional[StrictStr] = None
    target_date: Optional[StrictStr] = Field(default=None, description="The target date used to determine which receivables to be collected in the payment run.  ", alias="targetDate")
    updated_by_id: Optional[StrictStr] = Field(default=None, description="The ID of the Zuora user who last updated the payment run. ", alias="updatedById")
    updated_date: Optional[StrictStr] = Field(default=None, description="The date and time when the payment run was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10. ", alias="updatedDate")
    organization_labels: Optional[List[OrganizationLabel]] = Field(default=None, description="The organization(s) that the payment run is created for.  For each item in the array, either the `organizationId` or the `organizationName` field is required.  This field is only required when you have already turned on Multi-Org feature. ", alias="organizationLabels")
    process_id: Optional[StrictStr] = Field(default=None, description="The Id of the process that handle the operation. ", alias="processId")
    request_id: Optional[StrictStr] = Field(default=None, description="Unique request identifier. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution. ", alias="requestId")
    reasons: Optional[List[FailedReason]] = None
    success: Optional[StrictBool] = Field(default=None, description="Indicates whether the call succeeded. ")
    additional_properties: Dict[str, Any] = {}
    __properties: ClassVar[List[str]] = ["accountId", "applyCreditBalance", "autoApplyCreditMemo", "autoApplyUnappliedPayment", "batch", "billCycleDay", "billingRunId", "collectPayment", "completedOn", "consolidatedPayment", "createdById", "createdDate", "currency", "executedOn", "id", "number", "paymentGatewayId", "processPaymentWithClosedPM", "runDate", "paymentGatewayNumber", "status", "targetDate", "updatedById", "updatedDate", "organizationLabels", "processId", "requestId", "reasons", "success"]

    model_config = ConfigDict(
        populate_by_name=True,
        validate_assignment=True,
        protected_namespaces=(),
    )


    def to_str(self) -> str:
        """Returns the string representation of the model using alias"""
        return pprint.pformat(self.model_dump(by_alias=True))

    def to_json(self) -> str:
        """Returns the JSON representation of the model using alias"""
        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
        return json.dumps(self.to_dict())

    @classmethod
    def from_json(cls, json_str: str) -> Optional[Self]:
        """Create an instance of PaymentRunResponse from a JSON string"""
        return cls.from_dict(json.loads(json_str))

    def to_dict(self) -> Dict[str, Any]:
        """Return the dictionary representation of the model using alias.

        This has the following differences from calling pydantic's
        `self.model_dump(by_alias=True)`:

        * `None` is only added to the output dict for nullable fields that
          were set at model initialization. Other fields with value `None`
          are ignored.
        * Fields in `self.additional_properties` are added to the output dict.
        """
        excluded_fields: Set[str] = set([
            "additional_properties",
        ])

        _dict = self.model_dump(
            by_alias=True,
            exclude=excluded_fields,
            exclude_none=True,
        )
        # override the default output from pydantic by calling `to_dict()` of each item in organization_labels (list)
        _items = []
        if self.organization_labels:
            for _item_organization_labels in self.organization_labels:
                if _item_organization_labels:
                    _items.append(_item_organization_labels.to_dict())
            _dict['organizationLabels'] = _items
        # override the default output from pydantic by calling `to_dict()` of each item in reasons (list)
        _items = []
        if self.reasons:
            for _item_reasons in self.reasons:
                if _item_reasons:
                    _items.append(_item_reasons.to_dict())
            _dict['reasons'] = _items
        # puts key-value pairs in additional_properties in the top level
        if self.additional_properties is not None:
            for _key, _value in self.additional_properties.items():
                _dict[_key] = _value

        return _dict

    @classmethod
    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
        """Create an instance of PaymentRunResponse from a dict"""
        if obj is None:
            return None

        if not isinstance(obj, dict):
            return cls.model_validate(obj)

        obj = convert_snake_dict_to_camel(obj, cls.model_fields, cls.__properties)

        _obj = cls.model_validate(cls.to_alias_dict(obj))
        return cls.update_additional_properties(_obj, obj)

    @classmethod
    def update_additional_properties(cls, obj, _dict: Optional[Dict[str, Any]]):
        # store additional fields in additional_properties

        # store additional fields in additional_properties
        for _key in _dict.keys():
            if _key not in cls.__properties:
                obj.additional_properties[_key] = _dict.get(_key)


        return obj
        pass

    @classmethod
    def to_alias_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Dict[str, Any]]:

        if not isinstance(obj, dict):
            return cls.model_validate(obj)

        return {
            "accountId": obj.get("accountId"),
            "applyCreditBalance": obj.get("applyCreditBalance"),
            "autoApplyCreditMemo": obj.get("autoApplyCreditMemo"),
            "autoApplyUnappliedPayment": obj.get("autoApplyUnappliedPayment"),
            "batch": obj.get("batch"),
            "billCycleDay": obj.get("billCycleDay"),
            "billingRunId": obj.get("billingRunId"),
            "collectPayment": obj.get("collectPayment"),
            "completedOn": obj.get("completedOn"),
            "consolidatedPayment": obj.get("consolidatedPayment"),
            "createdById": obj.get("createdById"),
            "createdDate": obj.get("createdDate"),
            "currency": obj.get("currency"),
            "executedOn": obj.get("executedOn"),
            "id": obj.get("id"),
            "number": obj.get("number"),
            "paymentGatewayId": obj.get("paymentGatewayId"),
            "processPaymentWithClosedPM": obj.get("processPaymentWithClosedPM"),
            "runDate": obj.get("runDate"),
            "paymentGatewayNumber": obj.get("paymentGatewayNumber"),
            "status": obj.get("status"),
            "targetDate": obj.get("targetDate"),
            "updatedById": obj.get("updatedById"),
            "updatedDate": obj.get("updatedDate"),
            "organizationLabels": [OrganizationLabel.from_dict(_item) for _item in obj["organizationLabels"]] if obj.get("organizationLabels") is not None else None,
            "processId": obj.get("processId"),
            "requestId": obj.get("requestId"),
            "reasons": [FailedReason.from_dict(_item) for _item in obj["reasons"]] if obj.get("reasons") is not None else None,
            "success": obj.get("success")
        }
        return _obj


def convert_snake_dict_to_camel(_dict: dict, model_fields, properties):
    if not isinstance(_dict, dict):
        return _dict
    new_dict = {}
    for k, v in _dict.items():
        if k in model_fields:
            # model_fields: key is attribute name like bill_to_contact,
            alias = model_fields.get(k).alias or k
            new_dict[alias] = v
            pass
        else:
            new_key = snake_to_camel(k)
            if properties is not None and isinstance(properties, list) and new_key in properties:
                new_dict[new_key] = v
            else:
                new_dict[k] = v
    return new_dict
    pass


def snake_to_camel(name):
    if name is None or '_' not in name:
        return name
    components = name.split('_')
    return components[0] + ''.join(x.title() for x in components[1:])
