solvimon-python-sdk 0.0.4b0__py3-none-any.whl

solvimon_python_sdk/models/payment_schedule_update_request.py

@@ -0,0 +1,204 @@
+# coding: utf-8
+
+"""
+    Solvimon API
+
+    Unified Solvimon API covering Configuration, Event, Identity, and Transaction domains.
+
+    The version of the OpenAPI document: 0.0.4-beta
+    Contact: contact@solvimon.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, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from solvimon_python_sdk.models.customer_update_request_transaction import CustomerUpdateRequestTransaction
+from solvimon_python_sdk.models.payment_method_fallback_update_request import PaymentMethodFallbackUpdateRequest
+from solvimon_python_sdk.models.payment_method_update_request_transaction import PaymentMethodUpdateRequestTransaction
+from solvimon_python_sdk.models.payment_schedule_dunning_update_request import PaymentScheduleDunningUpdateRequest
+from solvimon_python_sdk.models.payment_schedule_installments_update_request import PaymentScheduleInstallmentsUpdateRequest
+from solvimon_python_sdk.models.payment_schedule_one_off_update_request import PaymentScheduleOneOffUpdateRequest
+from solvimon_python_sdk.models.payment_schedule_recurring_update_request import PaymentScheduleRecurringUpdateRequest
+from solvimon_python_sdk.models.seller_details_update_request import SellerDetailsUpdateRequest
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class PaymentScheduleUpdateRequest(BaseModel):
+    """
+    PaymentScheduleUpdateRequest
+    """ # noqa: E501
+    object_type: Optional[StrictStr] = None
+    id: Optional[StrictStr] = None
+    created_at: Optional[StrictStr] = None
+    updated_at: Optional[StrictStr] = None
+    status: Optional[StrictStr] = None
+    customer_id: Optional[StrictStr] = Field(default=None, description="Resource ID of type CUSTOMER")
+    customer: Optional[CustomerUpdateRequestTransaction] = None
+    reference: Optional[Annotated[str, Field(min_length=0, strict=True, max_length=256)]] = None
+    description: Optional[StrictStr] = None
+    statement_descriptor: Optional[StrictStr] = None
+    payment_method_id: Optional[StrictStr] = Field(default=None, description="Resource ID of type PAYMENT_METHOD")
+    payment_method: Optional[PaymentMethodUpdateRequestTransaction] = None
+    billing_entity_id: Optional[StrictStr] = Field(default=None, description="Resource ID of type BILLING_ENTITY")
+    dunning: Optional[PaymentScheduleDunningUpdateRequest] = None
+    payment_method_fallback: Optional[PaymentMethodFallbackUpdateRequest] = None
+    type: Optional[StrictStr] = None
+    installments: Optional[PaymentScheduleInstallmentsUpdateRequest] = None
+    recurring: Optional[PaymentScheduleRecurringUpdateRequest] = None
+    one_off: Optional[PaymentScheduleOneOffUpdateRequest] = None
+    seller_details: Optional[SellerDetailsUpdateRequest] = None
+    __properties: ClassVar[List[str]] = ["object_type", "id", "created_at", "updated_at", "status", "customer_id", "customer", "reference", "description", "statement_descriptor", "payment_method_id", "payment_method", "billing_entity_id", "dunning", "payment_method_fallback", "type", "installments", "recurring", "one_off", "seller_details"]
+
+    @field_validator('status')
+    def status_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['ACTIVE', 'PAUSED', 'CANCELLED', 'DONE']):
+            raise ValueError("must be one of enum values ('ACTIVE', 'PAUSED', 'CANCELLED', 'DONE')")
+        return value
+
+    @field_validator('reference', mode="before")
+    def reference_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        if isinstance(value, str) and not re.match(r"^\S+$", value):
+            raise ValueError(r"must validate the regular expression /^\S+$/")
+        return value
+
+    @field_validator('type')
+    def type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['INSTALLMENTS', 'ONE_OFF', 'RECURRING']):
+            raise ValueError("must be one of enum values ('INSTALLMENTS', 'ONE_OFF', 'RECURRING')")
+        return value
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=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"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of PaymentScheduleUpdateRequest 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.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        """
+        excluded_fields: Set[str] = set([
+            "object_type",
+            "id",
+            "created_at",
+            "updated_at",
+            "status",
+            "customer",
+            "payment_method",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of customer
+        if self.customer:
+            _dict['customer'] = self.customer.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of payment_method
+        if self.payment_method:
+            _dict['payment_method'] = self.payment_method.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of dunning
+        if self.dunning:
+            _dict['dunning'] = self.dunning.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of payment_method_fallback
+        if self.payment_method_fallback:
+            _dict['payment_method_fallback'] = self.payment_method_fallback.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of installments
+        if self.installments:
+            _dict['installments'] = self.installments.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of recurring
+        if self.recurring:
+            _dict['recurring'] = self.recurring.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of one_off
+        if self.one_off:
+            _dict['one_off'] = self.one_off.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of seller_details
+        if self.seller_details:
+            _dict['seller_details'] = self.seller_details.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PaymentScheduleUpdateRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "object_type": obj.get("object_type"),
+            "id": obj.get("id"),
+            "created_at": obj.get("created_at"),
+            "updated_at": obj.get("updated_at"),
+            "status": obj.get("status"),
+            "customer_id": obj.get("customer_id"),
+            "customer": CustomerUpdateRequestTransaction.from_dict(obj["customer"]) if obj.get("customer") is not None else None,
+            "reference": obj.get("reference"),
+            "description": obj.get("description"),
+            "statement_descriptor": obj.get("statement_descriptor"),
+            "payment_method_id": obj.get("payment_method_id"),
+            "payment_method": PaymentMethodUpdateRequestTransaction.from_dict(obj["payment_method"]) if obj.get("payment_method") is not None else None,
+            "billing_entity_id": obj.get("billing_entity_id"),
+            "dunning": PaymentScheduleDunningUpdateRequest.from_dict(obj["dunning"]) if obj.get("dunning") is not None else None,
+            "payment_method_fallback": PaymentMethodFallbackUpdateRequest.from_dict(obj["payment_method_fallback"]) if obj.get("payment_method_fallback") is not None else None,
+            "type": obj.get("type"),
+            "installments": PaymentScheduleInstallmentsUpdateRequest.from_dict(obj["installments"]) if obj.get("installments") is not None else None,
+            "recurring": PaymentScheduleRecurringUpdateRequest.from_dict(obj["recurring"]) if obj.get("recurring") is not None else None,
+            "one_off": PaymentScheduleOneOffUpdateRequest.from_dict(obj["one_off"]) if obj.get("one_off") is not None else None,
+            "seller_details": SellerDetailsUpdateRequest.from_dict(obj["seller_details"]) if obj.get("seller_details") is not None else None
+        })
+        return _obj
+
+

solvimon_python_sdk/models/payment_trigger.py

@@ -0,0 +1,111 @@
+# coding: utf-8
+
+"""
+    Solvimon API
+
+    Unified Solvimon API covering Configuration, Event, Identity, and Transaction domains.
+
+    The version of the OpenAPI document: 0.0.4-beta
+    Contact: contact@solvimon.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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from solvimon_python_sdk.models.payment import Payment
+from solvimon_python_sdk.models.payment_trigger_event import PaymentTriggerEvent
+from solvimon_python_sdk.models.payment_trigger_manual import PaymentTriggerManual
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class PaymentTrigger(BaseModel):
+    """
+    Stores the payment reference and execution details used when a workflow runs for a payment.
+    """ # noqa: E501
+    payment_id: Optional[StrictStr] = Field(default=None, description="Payment that the workflow execution runs for.")
+    payment: Optional[Payment] = Field(default=None, description="The expanded payment that the workflow execution runs for.")
+    event: Optional[PaymentTriggerEvent] = Field(default=None, description="Event details recorded for payment executions created from system activity.")
+    manual: Optional[PaymentTriggerManual] = Field(default=None, description="Manual execution details recorded for payment triggers started by a user.")
+    __properties: ClassVar[List[str]] = ["payment_id", "payment", "event", "manual"]
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=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"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of PaymentTrigger 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.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        """
+        excluded_fields: Set[str] = set([
+            "payment",
+            "event",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of payment
+        if self.payment:
+            _dict['payment'] = self.payment.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of event
+        if self.event:
+            _dict['event'] = self.event.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of manual
+        if self.manual:
+            _dict['manual'] = self.manual.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PaymentTrigger from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "payment_id": obj.get("payment_id"),
+            "payment": Payment.from_dict(obj["payment"]) if obj.get("payment") is not None else None,
+            "event": PaymentTriggerEvent.from_dict(obj["event"]) if obj.get("event") is not None else None,
+            "manual": PaymentTriggerManual.from_dict(obj["manual"]) if obj.get("manual") is not None else None
+        })
+        return _obj
+
+

solvimon_python_sdk/models/payment_trigger_create_request.py

@@ -0,0 +1,111 @@
+# coding: utf-8
+
+"""
+    Solvimon API
+
+    Unified Solvimon API covering Configuration, Event, Identity, and Transaction domains.
+
+    The version of the OpenAPI document: 0.0.4-beta
+    Contact: contact@solvimon.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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from solvimon_python_sdk.models.payment import Payment
+from solvimon_python_sdk.models.payment_trigger_event import PaymentTriggerEvent
+from solvimon_python_sdk.models.payment_trigger_manual import PaymentTriggerManual
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class PaymentTriggerCreateRequest(BaseModel):
+    """
+    Stores the payment reference and execution details used when a workflow runs for a payment.
+    """ # noqa: E501
+    payment_id: Optional[StrictStr] = Field(default=None, description="Payment that the workflow execution runs for.")
+    payment: Optional[Payment] = Field(default=None, description="The expanded payment that the workflow execution runs for.")
+    event: Optional[PaymentTriggerEvent] = Field(default=None, description="Event details recorded for payment executions created from system activity.")
+    manual: Optional[PaymentTriggerManual] = Field(default=None, description="Manual execution details recorded for payment triggers started by a user.")
+    __properties: ClassVar[List[str]] = ["payment_id", "payment", "event", "manual"]
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=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"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of PaymentTriggerCreateRequest 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.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        """
+        excluded_fields: Set[str] = set([
+            "payment",
+            "event",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of payment
+        if self.payment:
+            _dict['payment'] = self.payment.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of event
+        if self.event:
+            _dict['event'] = self.event.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of manual
+        if self.manual:
+            _dict['manual'] = self.manual.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PaymentTriggerCreateRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "payment_id": obj.get("payment_id"),
+            "payment": Payment.from_dict(obj["payment"]) if obj.get("payment") is not None else None,
+            "event": PaymentTriggerEvent.from_dict(obj["event"]) if obj.get("event") is not None else None,
+            "manual": PaymentTriggerManual.from_dict(obj["manual"]) if obj.get("manual") is not None else None
+        })
+        return _obj
+
+

solvimon_python_sdk/models/payment_trigger_event.py

@@ -0,0 +1,99 @@
+# coding: utf-8
+
+"""
+    Solvimon API
+
+    Unified Solvimon API covering Configuration, Event, Identity, and Transaction domains.
+
+    The version of the OpenAPI document: 0.0.4-beta
+    Contact: contact@solvimon.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, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class PaymentTriggerEvent(BaseModel):
+    """
+    Defines event details captured for payment workflow triggers.
+    """ # noqa: E501
+    variant: Optional[StrictStr] = Field(default=None, description="Payment workflow variant used for the execution.")
+    __properties: ClassVar[List[str]] = ["variant"]
+
+    @field_validator('variant')
+    def variant_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['FAILED_PAYMENT']):
+            raise ValueError("must be one of enum values ('FAILED_PAYMENT')")
+        return value
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=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"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of PaymentTriggerEvent 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.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PaymentTriggerEvent from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "variant": obj.get("variant")
+        })
+        return _obj
+
+

solvimon_python_sdk/models/payment_trigger_manual.py

@@ -0,0 +1,103 @@
+# coding: utf-8
+
+"""
+    Solvimon API
+
+    Unified Solvimon API covering Configuration, Event, Identity, and Transaction domains.
+
+    The version of the OpenAPI document: 0.0.4-beta
+    Contact: contact@solvimon.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, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class PaymentTriggerManual(BaseModel):
+    """
+    Defines manual execution details captured for a payment trigger.
+    """ # noqa: E501
+    user_id: Optional[StrictStr] = Field(default=None, description="User who created the manual trigger execution.")
+    variant: Optional[StrictStr] = Field(default=None, description="Payment workflow variant selected for the manual execution.")
+    __properties: ClassVar[List[str]] = ["user_id", "variant"]
+
+    @field_validator('variant')
+    def variant_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['FAILED_PAYMENT']):
+            raise ValueError("must be one of enum values ('FAILED_PAYMENT')")
+        return value
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=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"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of PaymentTriggerManual 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.
+        * OpenAPI `readOnly` fields are excluded.
+        """
+        excluded_fields: Set[str] = set([
+            "user_id",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PaymentTriggerManual from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "user_id": obj.get("user_id"),
+            "variant": obj.get("variant")
+        })
+        return _obj
+
+