vortex-sdk 0.2.0__py3-none-any.whl

vortex/models/coupon_targets.py

@@ -0,0 +1,89 @@
+# 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 typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class CouponTargets(BaseModel):
+    """
+    CouponTargets
+    """ # noqa: E501
+    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]] = ["priceIds", "meterIds"]
+
+    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 CouponTargets 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 CouponTargets from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "priceIds": obj.get("priceIds"),
+            "meterIds": obj.get("meterIds")
+        })
+        return _obj

vortex/models/create_checkout_session_request.py

@@ -0,0 +1,140 @@
+# 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 datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from vortex.models.checkout_session_line_item_request import CheckoutSessionLineItemRequest
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class CreateCheckoutSessionRequest(BaseModel):
+    """
+    CreateCheckoutSessionRequest
+    """ # noqa: E501
+    mode: Optional[StrictStr] = None
+    invoice_number: Optional[StrictStr] = Field(default=None, alias="invoiceNumber")
+    invoice_numbers: Optional[Annotated[List[StrictStr], Field(min_length=1)]] = Field(default=None, alias="invoiceNumbers")
+    customer_external_id: Optional[StrictStr] = Field(default=None, alias="customerExternalId")
+    billing_account_id: Optional[StrictStr] = Field(default=None, alias="billingAccountId")
+    subscription_external_id: Optional[StrictStr] = Field(default=None, alias="subscriptionExternalId")
+    collection_mode: Optional[StrictStr] = Field(default=None, alias="collectionMode")
+    start_at: Optional[datetime] = Field(default=None, alias="startAt")
+    line_items: Optional[Annotated[List[CheckoutSessionLineItemRequest], Field(min_length=1)]] = Field(default=None, alias="lineItems")
+    payment_request_id: Optional[StrictStr] = Field(default=None, alias="paymentRequestId")
+    expires_at: Optional[datetime] = Field(default=None, alias="expiresAt")
+    created_by_ref: Optional[StrictStr] = Field(default=None, alias="createdByRef")
+    metadata: Optional[Dict[str, StrictStr]] = None
+    __properties: ClassVar[List[str]] = ["mode", "invoiceNumber", "invoiceNumbers", "customerExternalId", "billingAccountId", "subscriptionExternalId", "collectionMode", "startAt", "lineItems", "paymentRequestId", "expiresAt", "createdByRef", "metadata"]
+
+    @field_validator('mode')
+    def mode_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['payment', 'subscription']):
+            raise ValueError("must be one of enum values ('payment', 'subscription')")
+        return value
+
+    @field_validator('collection_mode')
+    def collection_mode_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['manual', 'automatic']):
+            raise ValueError("must be one of enum values ('manual', 'automatic')")
+        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 CreateCheckoutSessionRequest 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 line_items (list)
+        _items = []
+        if self.line_items:
+            for _item_line_items in self.line_items:
+                if _item_line_items:
+                    _items.append(_item_line_items.to_dict())
+            _dict['lineItems'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CreateCheckoutSessionRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "mode": obj.get("mode"),
+            "invoiceNumber": obj.get("invoiceNumber"),
+            "invoiceNumbers": obj.get("invoiceNumbers"),
+            "customerExternalId": obj.get("customerExternalId"),
+            "billingAccountId": obj.get("billingAccountId"),
+            "subscriptionExternalId": obj.get("subscriptionExternalId"),
+            "collectionMode": obj.get("collectionMode"),
+            "startAt": obj.get("startAt"),
+            "lineItems": [CheckoutSessionLineItemRequest.from_dict(_item) for _item in obj["lineItems"]] if obj.get("lineItems") is not None else None,
+            "paymentRequestId": obj.get("paymentRequestId"),
+            "expiresAt": obj.get("expiresAt"),
+            "createdByRef": obj.get("createdByRef"),
+            "metadata": obj.get("metadata")
+        })
+        return _obj

vortex/models/create_coupon_request.py

@@ -0,0 +1,132 @@
+# 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 datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing_extensions import Annotated
+from vortex.models.coupon_targets import CouponTargets
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class CreateCouponRequest(BaseModel):
+    """
+    CreateCouponRequest
+    """ # noqa: E501
+    coupon_id: Optional[StrictStr] = Field(default=None, alias="couponId")
+    code: StrictStr
+    name: StrictStr
+    description: Optional[StrictStr] = None
+    discount_type: StrictStr = Field(alias="discountType")
+    amount: Optional[Annotated[int, Field(strict=True, ge=1)]] = None
+    currency: Optional[StrictStr] = Field(default=None, description="ISO 4217 alpha-3; only currencies processable on current rails are accepted", json_schema_extra={"examples": ["USD"]})
+    percentage: Optional[Union[Annotated[float, Field(le=100, strict=True, ge=0)], Annotated[int, Field(le=100, strict=True, ge=0)]]] = None
+    duration: StrictStr
+    duration_in_billing_periods: Optional[Annotated[int, Field(strict=True, ge=1)]] = Field(default=None, alias="durationInBillingPeriods")
+    reusable: Optional[StrictBool] = None
+    targets: Optional[CouponTargets] = None
+    expires_at: Optional[datetime] = Field(default=None, alias="expiresAt")
+    metadata: Optional[Dict[str, StrictStr]] = None
+    __properties: ClassVar[List[str]] = ["couponId", "code", "name", "description", "discountType", "amount", "currency", "percentage", "duration", "durationInBillingPeriods", "reusable", "targets", "expiresAt", "metadata"]
+
+    @field_validator('discount_type')
+    def discount_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['fixed_amount', 'percentage']):
+            raise ValueError("must be one of enum values ('fixed_amount', 'percentage')")
+        return value
+
+    @field_validator('duration')
+    def duration_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['once', 'repeating', 'forever']):
+            raise ValueError("must be one of enum values ('once', 'repeating', 'forever')")
+        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 CreateCouponRequest 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 targets
+        if self.targets:
+            _dict['targets'] = self.targets.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CreateCouponRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "couponId": obj.get("couponId"),
+            "code": obj.get("code"),
+            "name": obj.get("name"),
+            "description": obj.get("description"),
+            "discountType": obj.get("discountType"),
+            "amount": obj.get("amount"),
+            "currency": obj.get("currency"),
+            "percentage": obj.get("percentage"),
+            "duration": obj.get("duration"),
+            "durationInBillingPeriods": obj.get("durationInBillingPeriods"),
+            "reusable": obj.get("reusable"),
+            "targets": CouponTargets.from_dict(obj["targets"]) if obj.get("targets") is not None else None,
+            "expiresAt": obj.get("expiresAt"),
+            "metadata": obj.get("metadata")
+        })
+        return _obj

vortex/models/create_deposit_balance_payable_request.py

@@ -0,0 +1,172 @@
+# 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, StrictBool, 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 CreateDepositBalancePayableRequest(BaseModel):
+    """
+    CreateDepositBalancePayableRequest
+    """ # noqa: E501
+    source_type: StrictStr = Field(alias="sourceType")
+    source_id: StrictStr = Field(alias="sourceId")
+    document_id: StrictStr = Field(alias="documentId")
+    payment_field_id: StrictStr = Field(alias="paymentFieldId")
+    customer_external_id: StrictStr = Field(alias="customerExternalId")
+    billing_account_id: StrictStr = Field(alias="billingAccountId")
+    merchant_account_id: Optional[StrictStr] = Field(default=None, alias="merchantAccountId")
+    currency: StrictStr = Field(description="ISO 4217 alpha-3; only currencies processable on current rails are accepted", json_schema_extra={"examples": ["USD"]})
+    tax_mode: StrictStr = Field(alias="taxMode")
+    taxable: Optional[StrictBool] = None
+    tax_behavior: Optional[StrictStr] = Field(default=None, alias="taxBehavior")
+    tax_classification_key: Optional[StrictStr] = Field(default=None, alias="taxClassificationKey")
+    collection_intent: StrictStr = Field(alias="collectionIntent")
+    fee_policy: Dict[str, Any] = Field(description="Adopter fee policy (modeled, not settlement-executed). Structure passed through to Vortex Payments.", alias="feePolicy")
+    deposit: Dict[str, Any]
+    balance: Dict[str, Any]
+    metadata: Dict[str, StrictStr]
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["sourceType", "sourceId", "documentId", "paymentFieldId", "customerExternalId", "billingAccountId", "merchantAccountId", "currency", "taxMode", "taxable", "taxBehavior", "taxClassificationKey", "collectionIntent", "feePolicy", "deposit", "balance", "metadata"]
+
+    @field_validator('source_type')
+    def source_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['document_payment_field']):
+            raise ValueError("must be one of enum values ('document_payment_field')")
+        return value
+
+    @field_validator('tax_mode')
+    def tax_mode_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['not_taxable', 'taxable_requires_evidence']):
+            raise ValueError("must be one of enum values ('not_taxable', 'taxable_requires_evidence')")
+        return value
+
+    @field_validator('tax_behavior')
+    def tax_behavior_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['inclusive', 'exclusive']):
+            raise ValueError("must be one of enum values ('inclusive', 'exclusive')")
+        return value
+
+    @field_validator('tax_classification_key')
+    def tax_classification_key_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['standard_taxable']):
+            raise ValueError("must be one of enum values ('standard_taxable')")
+        return value
+
+    @field_validator('collection_intent')
+    def collection_intent_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['manual']):
+            raise ValueError("must be one of enum values ('manual')")
+        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 CreateDepositBalancePayableRequest 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,
+        )
+        # 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 CreateDepositBalancePayableRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "sourceType": obj.get("sourceType"),
+            "sourceId": obj.get("sourceId"),
+            "documentId": obj.get("documentId"),
+            "paymentFieldId": obj.get("paymentFieldId"),
+            "customerExternalId": obj.get("customerExternalId"),
+            "billingAccountId": obj.get("billingAccountId"),
+            "merchantAccountId": obj.get("merchantAccountId"),
+            "currency": obj.get("currency"),
+            "taxMode": obj.get("taxMode"),
+            "taxable": obj.get("taxable"),
+            "taxBehavior": obj.get("taxBehavior"),
+            "taxClassificationKey": obj.get("taxClassificationKey"),
+            "collectionIntent": obj.get("collectionIntent"),
+            "feePolicy": obj.get("feePolicy"),
+            "deposit": obj.get("deposit"),
+            "balance": obj.get("balance"),
+            "metadata": obj.get("metadata")
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj