vortex-sdk 0.2.0__py3-none-any.whl

vortex/exceptions.py

@@ -0,0 +1,218 @@
+"""
+    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 typing import Any, Optional
+from typing_extensions import Self
+
+class OpenApiException(Exception):
+    """The base exception class for all OpenAPIExceptions"""
+
+
+class ApiTypeError(OpenApiException, TypeError):
+    def __init__(self, msg, path_to_item=None, valid_classes=None,
+                 key_type=None) -> None:
+        """ Raises an exception for TypeErrors
+
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (list): a list of keys an indices to get to the
+                                 current_item
+                                 None if unset
+            valid_classes (tuple): the primitive classes that current item
+                                   should be an instance of
+                                   None if unset
+            key_type (bool): False if our value is a value in a dict
+                             True if it is a key in a dict
+                             False if our item is an item in a list
+                             None if unset
+        """
+        self.path_to_item = path_to_item
+        self.valid_classes = valid_classes
+        self.key_type = key_type
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiTypeError, self).__init__(full_msg)
+
+
+class ApiValueError(OpenApiException, ValueError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (list) the path to the exception in the
+                received_data dict. None if unset
+        """
+
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiValueError, self).__init__(full_msg)
+
+
+class ApiAttributeError(OpenApiException, AttributeError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Raised when an attribute reference or assignment fails.
+
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (None/list) the path to the exception in the
+                received_data dict
+        """
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiAttributeError, self).__init__(full_msg)
+
+
+class ApiKeyError(OpenApiException, KeyError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (None/list) the path to the exception in the
+                received_data dict
+        """
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiKeyError, self).__init__(full_msg)
+
+
+class ApiException(OpenApiException):
+
+    def __init__(
+        self,
+        status=None,
+        reason=None,
+        http_resp=None,
+        *,
+        body: Optional[str] = None,
+        data: Optional[Any] = None,
+    ) -> None:
+        self.status = status
+        self.reason = reason
+        self.body = body
+        self.data = data
+        self.headers = None
+
+        if http_resp:
+            if self.status is None:
+                self.status = http_resp.status
+            if self.reason is None:
+                self.reason = http_resp.reason
+            if self.body is None:
+                try:
+                    self.body = http_resp.data.decode('utf-8')
+                except Exception:
+                    pass
+            self.headers = http_resp.headers
+
+    @classmethod
+    def from_response(
+        cls,
+        *,
+        http_resp,
+        body: Optional[str],
+        data: Optional[Any],
+    ) -> Self:
+        if http_resp.status == 400:
+            raise BadRequestException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 401:
+            raise UnauthorizedException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 403:
+            raise ForbiddenException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 404:
+            raise NotFoundException(http_resp=http_resp, body=body, data=data)
+
+        # Added new conditions for 409 and 422
+        if http_resp.status == 409:
+            raise ConflictException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 422:
+            raise UnprocessableEntityException(http_resp=http_resp, body=body, data=data)
+
+        if 500 <= http_resp.status <= 599:
+            raise ServiceException(http_resp=http_resp, body=body, data=data)
+        raise ApiException(http_resp=http_resp, body=body, data=data)
+
+    def __str__(self):
+        """Custom error messages for exception"""
+        error_message = "({0})\n"\
+                        "Reason: {1}\n".format(self.status, self.reason)
+        if self.headers:
+            error_message += "HTTP response headers: {0}\n".format(
+                self.headers)
+
+        if self.body:
+            error_message += "HTTP response body: {0}\n".format(self.body)
+
+        if self.data:
+            error_message += "HTTP response data: {0}\n".format(self.data)
+
+        return error_message
+
+
+class BadRequestException(ApiException):
+    pass
+
+
+class NotFoundException(ApiException):
+    pass
+
+
+class UnauthorizedException(ApiException):
+    pass
+
+
+class ForbiddenException(ApiException):
+    pass
+
+
+class ServiceException(ApiException):
+    pass
+
+
+class ConflictException(ApiException):
+    """Exception for HTTP 409 Conflict."""
+    pass
+
+
+class UnprocessableEntityException(ApiException):
+    """Exception for HTTP 422 Unprocessable Entity."""
+    pass
+
+
+def render_path(path_to_item):
+    """Returns a string representation of a path"""
+    result = ""
+    for pth in path_to_item:
+        if isinstance(pth, int):
+            result += "[{0}]".format(pth)
+        else:
+            result += "['{0}']".format(pth)
+    return result

vortex/models/__init__.py

@@ -0,0 +1,104 @@
+# coding: utf-8
+
+# flake8: noqa
+"""
+    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
+
+# import models into model package
+from vortex.models.api_error import ApiError
+from vortex.models.api_error_error import ApiErrorError
+from vortex.models.api_write_envelope import ApiWriteEnvelope
+from vortex.models.apply_coupon_request import ApplyCouponRequest
+from vortex.models.billing_order_form_sign_request import BillingOrderFormSignRequest
+from vortex.models.billing_order_form_signature_request_request import BillingOrderFormSignatureRequestRequest
+from vortex.models.billing_order_form_void_request import BillingOrderFormVoidRequest
+from vortex.models.billing_order_forms_expire_due_request import BillingOrderFormsExpireDueRequest
+from vortex.models.billing_order_update_request import BillingOrderUpdateRequest
+from vortex.models.billing_orders_execute_due_request import BillingOrdersExecuteDueRequest
+from vortex.models.billing_quote_create_request import BillingQuoteCreateRequest
+from vortex.models.billing_quote_line_input import BillingQuoteLineInput
+from vortex.models.billing_quote_version_approve_request import BillingQuoteVersionApproveRequest
+from vortex.models.billing_quote_version_create_request import BillingQuoteVersionCreateRequest
+from vortex.models.billing_quote_version_update_request import BillingQuoteVersionUpdateRequest
+from vortex.models.billing_quote_version_void_request import BillingQuoteVersionVoidRequest
+from vortex.models.checkout_session_line_item_request import CheckoutSessionLineItemRequest
+from vortex.models.coupon_targets import CouponTargets
+from vortex.models.create_checkout_session_request import CreateCheckoutSessionRequest
+from vortex.models.create_coupon_request import CreateCouponRequest
+from vortex.models.create_deposit_balance_payable_request import CreateDepositBalancePayableRequest
+from vortex.models.create_installment_payable_request import CreateInstallmentPayableRequest
+from vortex.models.create_payable_request import CreatePayableRequest
+from vortex.models.create_recurring_payable_request import CreateRecurringPayableRequest
+from vortex.models.create_recurring_payable_request_cadence import CreateRecurringPayableRequestCadence
+from vortex.models.credit_note_create_line import CreditNoteCreateLine
+from vortex.models.credit_note_create_request import CreditNoteCreateRequest
+from vortex.models.credit_note_reason import CreditNoteReason
+from vortex.models.credit_note_refund_reconcile_request import CreditNoteRefundReconcileRequest
+from vortex.models.credit_note_refund_request import CreditNoteRefundRequest
+from vortex.models.customer_balance_targets import CustomerBalanceTargets
+from vortex.models.customer_default_payment_method_request import CustomerDefaultPaymentMethodRequest
+from vortex.models.customer_payment_method_archive_request import CustomerPaymentMethodArchiveRequest
+from vortex.models.customer_payment_method_attach_request import CustomerPaymentMethodAttachRequest
+from vortex.models.customer_payment_method_setup_request import CustomerPaymentMethodSetupRequest
+from vortex.models.customer_upsert_request import CustomerUpsertRequest
+from vortex.models.expire_customer_balance_request import ExpireCustomerBalanceRequest
+from vortex.models.grant_customer_balance_from_payment_request import GrantCustomerBalanceFromPaymentRequest
+from vortex.models.grant_customer_balance_request import GrantCustomerBalanceRequest
+from vortex.models.grant_entitlement_request import GrantEntitlementRequest
+from vortex.models.invoice_collect_request import InvoiceCollectRequest
+from vortex.models.invoice_create_request import InvoiceCreateRequest
+from vortex.models.invoice_finalize_request import InvoiceFinalizeRequest
+from vortex.models.invoice_mark_uncollectible_request import InvoiceMarkUncollectibleRequest
+from vortex.models.invoice_tax import InvoiceTax
+from vortex.models.invoice_void_request import InvoiceVoidRequest
+from vortex.models.merchant_account_create_request import MerchantAccountCreateRequest
+from vortex.models.merchant_address import MerchantAddress
+from vortex.models.merchant_associated_identity import MerchantAssociatedIdentity
+from vortex.models.merchant_onboarding_link_request import MerchantOnboardingLinkRequest
+from vortex.models.merchant_profile_date import MerchantProfileDate
+from vortex.models.merchant_settlement_bank_account import MerchantSettlementBankAccount
+from vortex.models.merchant_tax_profile_request import MerchantTaxProfileRequest
+from vortex.models.merchant_tax_profile_request_registrations_inner import MerchantTaxProfileRequestRegistrationsInner
+from vortex.models.merchant_underwriting_data import MerchantUnderwritingData
+from vortex.models.merchant_underwriting_data_card_volume_distribution import MerchantUnderwritingDataCardVolumeDistribution
+from vortex.models.merchant_underwriting_data_volume_distribution_by_business_type import MerchantUnderwritingDataVolumeDistributionByBusinessType
+from vortex.models.open_api_invoice_tax_response import OpenApiInvoiceTaxResponse
+from vortex.models.open_api_invoice_tax_response_all_of_data import OpenApiInvoiceTaxResponseAllOfData
+from vortex.models.payment_request_collect_request import PaymentRequestCollectRequest
+from vortex.models.payment_request_create_request import PaymentRequestCreateRequest
+from vortex.models.payment_request_link_create_request import PaymentRequestLinkCreateRequest
+from vortex.models.price_create_request import PriceCreateRequest
+from vortex.models.product_create_request import ProductCreateRequest
+from vortex.models.reverse_customer_balance_request import ReverseCustomerBalanceRequest
+from vortex.models.revoke_entitlement_request import RevokeEntitlementRequest
+from vortex.models.subscription_change_request import SubscriptionChangeRequest
+from vortex.models.subscription_create_request import SubscriptionCreateRequest
+from vortex.models.subscription_item_change_preview_request import SubscriptionItemChangePreviewRequest
+from vortex.models.subscription_item_change_request_item import SubscriptionItemChangeRequestItem
+from vortex.models.tax_address import TaxAddress
+from vortex.models.tax_behavior import TaxBehavior
+from vortex.models.tax_behavior_policy import TaxBehaviorPolicy
+from vortex.models.tax_behavior_policy_request import TaxBehaviorPolicyRequest
+from vortex.models.tax_failure import TaxFailure
+from vortex.models.tax_finalize_request import TaxFinalizeRequest
+from vortex.models.tax_jurisdiction_evidence import TaxJurisdictionEvidence
+from vortex.models.tax_line_evidence import TaxLineEvidence
+from vortex.models.tax_quote_request import TaxQuoteRequest
+from vortex.models.terminate_applied_coupon_request import TerminateAppliedCouponRequest
+from vortex.models.terminate_coupon_request import TerminateCouponRequest
+from vortex.models.webhook_deliveries_dispatch_request import WebhookDeliveriesDispatchRequest
+from vortex.models.webhook_deliveries_redrive_request import WebhookDeliveriesRedriveRequest
+from vortex.models.webhook_delivery_replay_request import WebhookDeliveryReplayRequest
+from vortex.models.webhook_endpoint_create_request import WebhookEndpointCreateRequest
+from vortex.models.webhook_endpoint_secret_rotate_request import WebhookEndpointSecretRotateRequest
+from vortex.models.webhook_endpoint_test_request import WebhookEndpointTestRequest
+from vortex.models.webhook_endpoint_update_request import WebhookEndpointUpdateRequest
+from vortex.models.webhook_event_resend_request import WebhookEventResendRequest

vortex/models/api_error.py

@@ -0,0 +1,103 @@
+# 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
+from typing import Any, ClassVar, Dict, List
+from vortex.models.api_error_error import ApiErrorError
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class ApiError(BaseModel):
+    """
+    ApiError
+    """ # noqa: E501
+    error: ApiErrorError
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["error"]
+
+    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 ApiError 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 error
+        if self.error:
+            _dict['error'] = self.error.to_dict()
+        # 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 ApiError from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "error": ApiErrorError.from_dict(obj["error"]) if obj.get("error") is not None else None
+        })
+        # 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

vortex/models/api_error_error.py

@@ -0,0 +1,114 @@
+# 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 import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class ApiErrorError(BaseModel):
+    """
+    ApiErrorError
+    """ # noqa: E501
+    code: StrictStr
+    message: StrictStr
+    request_id: Optional[StrictStr] = Field(default=None, alias="requestId")
+    docs_url: Optional[StrictStr] = Field(default=None, description="Deep link to the errors guide section for this code.", alias="docsUrl")
+    details: Optional[Dict[str, Any]] = None
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["code", "message", "requestId", "docsUrl", "details"]
+
+    @field_validator('code')
+    def code_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['bad_request', 'unauthorized', 'forbidden', 'not_found', 'conflict', 'rate_limited', 'validation_failure', 'not_implemented', 'internal_error']):
+            raise ValueError("must be one of enum values ('bad_request', 'unauthorized', 'forbidden', 'not_found', 'conflict', 'rate_limited', 'validation_failure', 'not_implemented', 'internal_error')")
+        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 ApiErrorError 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 ApiErrorError from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "code": obj.get("code"),
+            "message": obj.get("message"),
+            "requestId": obj.get("requestId"),
+            "docsUrl": obj.get("docsUrl"),
+            "details": obj.get("details")
+        })
+        # 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

vortex/models/api_write_envelope.py

@@ -0,0 +1,101 @@
+# 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
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class ApiWriteEnvelope(BaseModel):
+    """
+    ApiWriteEnvelope
+    """ # noqa: E501
+    data: Dict[str, Any]
+    request_id: StrictStr = Field(alias="requestId")
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["data", "requestId"]
+
+    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 ApiWriteEnvelope 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 ApiWriteEnvelope from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "data": obj.get("data"),
+            "requestId": obj.get("requestId")
+        })
+        # 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