vortex-sdk 0.2.0__py3-none-any.whl

vortex/models/credit_note_create_line.py

@@ -0,0 +1,105 @@
+# coding: utf-8
+
+"""
+    Vortex Payments API
+
+    Public Vortex Payments API for customers, subscriptions, invoices, payment requests, checkout, receipts, webhooks, tax.
+
+    The version of the OpenAPI document: 2026-08
+    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 typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class CreditNoteCreateLine(BaseModel):
+    """
+    CreditNoteCreateLine
+    """ # noqa: E501
+    invoice_line_id: Optional[StrictStr] = Field(default=None, alias="invoiceLineId")
+    bucket: Optional[StrictStr] = None
+    description: StrictStr
+    amount: Annotated[int, Field(strict=True, ge=1)]
+    metadata: Optional[Dict[str, StrictStr]] = None
+    __properties: ClassVar[List[str]] = ["invoiceLineId", "bucket", "description", "amount", "metadata"]
+
+    @field_validator('bucket')
+    def bucket_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['credit', 'refund', 'offset']):
+            raise ValueError("must be one of enum values ('credit', 'refund', 'offset')")
+        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 CreditNoteCreateLine 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 CreditNoteCreateLine from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "invoiceLineId": obj.get("invoiceLineId"),
+            "bucket": obj.get("bucket"),
+            "description": obj.get("description"),
+            "amount": obj.get("amount"),
+            "metadata": obj.get("metadata")
+        })
+        return _obj

vortex/models/credit_note_create_request.py

@@ -0,0 +1,112 @@
+# coding: utf-8
+
+"""
+    Vortex Payments API
+
+    Public Vortex Payments API for customers, subscriptions, invoices, payment requests, checkout, receipts, webhooks, tax.
+
+    The version of the OpenAPI document: 2026-08
+    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 typing_extensions import Annotated
+from vortex.models.credit_note_create_line import CreditNoteCreateLine
+from vortex.models.credit_note_reason import CreditNoteReason
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class CreditNoteCreateRequest(BaseModel):
+    """
+    CreditNoteCreateRequest
+    """ # noqa: E501
+    credit_note_id: Optional[StrictStr] = Field(default=None, alias="creditNoteId")
+    invoice_id: StrictStr = Field(alias="invoiceId")
+    reason: CreditNoteReason
+    description: Optional[StrictStr] = None
+    credit_amount: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, alias="creditAmount")
+    refund_amount: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, alias="refundAmount")
+    offset_amount: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, alias="offsetAmount")
+    metadata: Optional[Dict[str, StrictStr]] = None
+    lines: Annotated[List[CreditNoteCreateLine], Field(min_length=1)]
+    __properties: ClassVar[List[str]] = ["creditNoteId", "invoiceId", "reason", "description", "creditAmount", "refundAmount", "offsetAmount", "metadata", "lines"]
+
+    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 CreditNoteCreateRequest 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,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in lines (list)
+        _items = []
+        if self.lines:
+            for _item_lines in self.lines:
+                if _item_lines:
+                    _items.append(_item_lines.to_dict())
+            _dict['lines'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CreditNoteCreateRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "creditNoteId": obj.get("creditNoteId"),
+            "invoiceId": obj.get("invoiceId"),
+            "reason": obj.get("reason"),
+            "description": obj.get("description"),
+            "creditAmount": obj.get("creditAmount"),
+            "refundAmount": obj.get("refundAmount"),
+            "offsetAmount": obj.get("offsetAmount"),
+            "metadata": obj.get("metadata"),
+            "lines": [CreditNoteCreateLine.from_dict(_item) for _item in obj["lines"]] if obj.get("lines") is not None else None
+        })
+        return _obj

vortex/models/credit_note_reason.py

@@ -0,0 +1,39 @@
+# coding: utf-8
+
+"""
+    Vortex Payments API
+
+    Public Vortex Payments API for customers, subscriptions, invoices, payment requests, checkout, receipts, webhooks, tax.
+
+    The version of the OpenAPI document: 2026-08
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class CreditNoteReason(str, Enum):
+    """
+    CreditNoteReason
+    """
+
+    """
+    allowed enum values
+    """
+    DUPLICATED_CHARGE = 'duplicated_charge'
+    PRODUCT_UNSATISFACTORY = 'product_unsatisfactory'
+    ORDER_CHANGE = 'order_change'
+    ORDER_CANCELLATION = 'order_cancellation'
+    FRAUDULENT_CHARGE = 'fraudulent_charge'
+    OTHER = 'other'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of CreditNoteReason from a JSON string"""
+        return cls(json.loads(json_str))

vortex/models/credit_note_refund_reconcile_request.py

@@ -0,0 +1,86 @@
+# coding: utf-8
+
+"""
+    Vortex Payments API
+
+    Public Vortex Payments API for customers, subscriptions, invoices, payment requests, checkout, receipts, webhooks, tax.
+
+    The version of the OpenAPI document: 2026-08
+    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 typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class CreditNoteRefundReconcileRequest(BaseModel):
+    """
+    CreditNoteRefundReconcileRequest
+    """ # noqa: E501
+    payments_refund_id: Optional[StrictStr] = Field(default=None, alias="paymentsRefundId")
+    __properties: ClassVar[List[str]] = ["paymentsRefundId"]
+
+    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 CreditNoteRefundReconcileRequest 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 CreditNoteRefundReconcileRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "paymentsRefundId": obj.get("paymentsRefundId")
+        })
+        return _obj

vortex/models/credit_note_refund_request.py

@@ -0,0 +1,94 @@
+# coding: utf-8
+
+"""
+    Vortex Payments API
+
+    Public Vortex Payments API for customers, subscriptions, invoices, payment requests, checkout, receipts, webhooks, tax.
+
+    The version of the OpenAPI document: 2026-08
+    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 vortex.models.tax_address import TaxAddress
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class CreditNoteRefundRequest(BaseModel):
+    """
+    CreditNoteRefundRequest
+    """ # noqa: E501
+    payment_id: StrictStr = Field(alias="paymentId")
+    idempotency_key: Optional[StrictStr] = Field(default=None, alias="idempotencyKey")
+    customer_tax_address: Optional[TaxAddress] = Field(default=None, alias="customerTaxAddress")
+    __properties: ClassVar[List[str]] = ["paymentId", "idempotencyKey", "customerTaxAddress"]
+
+    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 CreditNoteRefundRequest 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,
+        )
+        # override the default output from pydantic by calling `to_dict()` of customer_tax_address
+        if self.customer_tax_address:
+            _dict['customerTaxAddress'] = self.customer_tax_address.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CreditNoteRefundRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "paymentId": obj.get("paymentId"),
+            "idempotencyKey": obj.get("idempotencyKey"),
+            "customerTaxAddress": TaxAddress.from_dict(obj["customerTaxAddress"]) if obj.get("customerTaxAddress") is not None else None
+        })
+        return _obj

vortex/models/customer_balance_targets.py

@@ -0,0 +1,102 @@
+# coding: utf-8
+
+"""
+    Vortex Payments API
+
+    Public Vortex Payments API for customers, subscriptions, invoices, payment requests, checkout, receipts, webhooks, tax.
+
+    The version of the OpenAPI document: 2026-08
+    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 typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class CustomerBalanceTargets(BaseModel):
+    """
+    CustomerBalanceTargets
+    """ # noqa: E501
+    line_types: Optional[Annotated[List[StrictStr], Field(min_length=1)]] = Field(default=None, alias="lineTypes")
+    price_ids: Optional[Annotated[List[StrictStr], Field(min_length=1)]] = Field(default=None, alias="priceIds")
+    meter_ids: Optional[Annotated[List[StrictStr], Field(min_length=1)]] = Field(default=None, alias="meterIds")
+    __properties: ClassVar[List[str]] = ["lineTypes", "priceIds", "meterIds"]
+
+    @field_validator('line_types')
+    def line_types_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        for i in value:
+            if i not in set(['fixed', 'usage', 'credit', 'adjustment', 'tax']):
+                raise ValueError("each list item must be one of ('fixed', 'usage', 'credit', 'adjustment', 'tax')")
+        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 CustomerBalanceTargets 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 CustomerBalanceTargets from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "lineTypes": obj.get("lineTypes"),
+            "priceIds": obj.get("priceIds"),
+            "meterIds": obj.get("meterIds")
+        })
+        return _obj

vortex/models/customer_default_payment_method_request.py

@@ -0,0 +1,88 @@
+# coding: utf-8
+
+"""
+    Vortex Payments API
+
+    Public Vortex Payments API for customers, subscriptions, invoices, payment requests, checkout, receipts, webhooks, tax.
+
+    The version of the OpenAPI document: 2026-08
+    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 typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class CustomerDefaultPaymentMethodRequest(BaseModel):
+    """
+    CustomerDefaultPaymentMethodRequest
+    """ # noqa: E501
+    billing_account_id: Optional[StrictStr] = Field(default=None, alias="billingAccountId")
+    default_payment_method_id: StrictStr = Field(alias="defaultPaymentMethodId")
+    __properties: ClassVar[List[str]] = ["billingAccountId", "defaultPaymentMethodId"]
+
+    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 CustomerDefaultPaymentMethodRequest 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 CustomerDefaultPaymentMethodRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "billingAccountId": obj.get("billingAccountId"),
+            "defaultPaymentMethodId": obj.get("defaultPaymentMethodId")
+        })
+        return _obj