python-easyverein 2.1.1__tar.gz → 2.2.0__tar.gz

{python_easyverein-2.1.1 → python_easyverein-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-easyverein
-Version: 2.1.1
+Version: 2.2.0
 Summary: Python library to interact with the EasyVerein API
 Author: Daniel Herrmann
 Author-email: daniel.herrmann1@gmail.com

{python_easyverein-2.1.1 → python_easyverein-2.2.0}/easyverein/__init__.py

@@ -2,7 +2,7 @@
 Middleware for FastAPI that supports authenticating users against Keycloak
 """
 
-__version__ = "2.1.1"
+__version__ = "2.2.0"
 
 # Export EasyVerein API directly
 from .api import EasyvereinAPI  # noqa: F401

{python_easyverein-2.1.1 → python_easyverein-2.2.0}/easyverein/api.py

@@ -7,6 +7,7 @@ from typing import Callable, cast
 
 from .core.client import EasyvereinClient
 from .core.responses import BearerToken
+from .modules.billing_account import BillingAccountMixin
 from .modules.booking import BookingMixin
 from .modules.contact_details import ContactDetailsMixin
 from .modules.custom_field import CustomFieldMixin
@@ -23,7 +24,7 @@ class EasyvereinAPI:
     def __init__(
         self,
         api_key,
-        api_version="v1.7",
+        api_version="v2.0",
         base_url: str = "https://easyverein.com/api/",
         logger: logging.Logger | None = None,
         auto_retry=False,
@@ -59,6 +60,7 @@ class EasyvereinAPI:
 
         # Add methods
         self.booking = BookingMixin(self.c, self.logger)
+        self.billing_account = BillingAccountMixin(self.c, self.logger)
         self.contact_details = ContactDetailsMixin(self.c, self.logger)
         self.custom_field = CustomFieldMixin(self.c, self.logger)
         self.invoice = InvoiceMixin(self.c, self.logger)

python_easyverein-2.2.0/easyverein/models/billing_account.py

@@ -0,0 +1,65 @@
+from __future__ import annotations
+
+from pydantic import BaseModel, PositiveInt
+
+from ..core.types import EasyVereinReference, FilterIntList, FilterStrList, PositiveIntWithZero
+from .base import EasyVereinBase
+from .mixins.empty_strings_mixin import EmptyStringsToNone
+from .mixins.required_attributes import required_mixin
+
+
+class BillingAccountBase(EasyVereinBase):
+    """
+    | Representative Model Class | Update Model Class | Create Model Class |
+    | --- | --- | --- |
+    | `BillingAccount` | `BillingAccountUpdate` | `BillingAccountCreate` |
+    """
+
+    name: str | None = None
+    excludeInEur: bool | None = None
+    number: PositiveInt | None = None
+    defaultSphere: PositiveInt | None = None
+
+
+class BillingAccount(BillingAccountBase, EmptyStringsToNone):
+    """
+    Pydantic model representing an BillingAccount
+    """
+
+    skr: str | None = None
+    accountingPlans: list[EasyVereinReference] | None = None
+    numberLength: PositiveIntWithZero
+    linkedBookings: PositiveIntWithZero
+
+
+class BillingAccountCreate(
+    BillingAccountBase,
+    required_mixin(["name", "number"]),  # type: ignore
+):
+    """
+    Pydantic model representing a BillingAccount
+    """
+
+
+class BillingAccountUpdate(BillingAccountBase):
+    """
+    Pydantic model used to patch an BillingAccount
+    """
+
+
+class BillingAccountFilter(BaseModel):
+    """
+    Pydantic model used to filter billing accounts
+    """
+
+    id__in: FilterIntList | None = None
+    name: str | None = None
+    skr: str | None = None
+    skr__in: FilterStrList | None = None
+    number__gte: PositiveInt | None = None
+    number__lte: PositiveInt | None = None
+    deleted: bool | None = None
+    accountingPlan__isnull: bool | None = None
+    showOwnBillingAccounts: bool | None = None
+    ordering: str | None = None
+    search: str | None = None

{python_easyverein-2.1.1 → python_easyverein-2.2.0}/easyverein/models/booking.py

@@ -22,8 +22,7 @@ class BookingBase(EasyVereinBase):
     amount: float | None = None
     # TODO: Add reference to BankAccount once implemented
     bankAccount: EasyVereinReference | None = None
-    # TODO: Add reference to BillingAccount once implemented
-    billingAccount: EasyVereinReference | None = None
+    billingAccount: BillingAccount | EasyVereinReference | None = None
     description: str | None = None
     date: DateTime | None = None
     receiver: str | None = None
@@ -98,3 +97,6 @@ class BookingFilter(BaseModel):
     relatedInvoice__isnull: bool | None = None
     relatedInvoice: int | None = None
     search: str | None = None
+
+
+from .billing_account import BillingAccount  # noqa: E402

{python_easyverein-2.1.1 → python_easyverein-2.2.0}/easyverein/models/contact_details.py

@@ -148,7 +148,7 @@ class ContactDetailsFilter(BaseModel):
 
     id__in: FilterIntList | None = None
     country: str | None = None
-    isCompany: bool = Field(default=None, serialization_alias="_isCompany")
+    isCompany: bool | None = Field(default=None, serialization_alias="_isCompany")
     preferredCommunicationWay: str | None = None
     contactDetailsGroups: str | None = None
     contactDetailsGroups__not: str | None = None

{python_easyverein-2.1.1 → python_easyverein-2.2.0}/easyverein/models/custom_field.py

@@ -111,6 +111,6 @@ class CustomFieldFilter(BaseModel):
     kind: str | None = None
     member_edit: bool | None = None
     member_show: bool | None = None
-    deletedBy__isnull: bool = Field(default=None, serialization_alias="_deletedBy__isnull")
+    deletedBy__isnull: bool | None = Field(default=None, serialization_alias="_deletedBy__isnull")
     deleted: bool | None = None
     ordering: str | None = None

{python_easyverein-2.1.1 → python_easyverein-2.2.0}/easyverein/models/invoice.py

@@ -55,8 +55,7 @@ class InvoiceBase(EasyVereinBase):
         ]
         | None
     ) = None
-    # TODO: Add reference to BillingAccount once implemented
-    selectionAcc: EasyVereinReference | None = None
+    selectionAcc: BillingAccount | EasyVereinReference | None = None
     refNumber: str | None = None
     paymentDifference: float | None = None
     isDraft: bool | None = None
@@ -148,6 +147,7 @@ class InvoiceFilter(BaseModel):
     search: str | None = None
 
 
+from .billing_account import BillingAccount  # noqa: E402
 from .contact_details import ContactDetails  # noqa: E402
 from .invoice_item import InvoiceItem  # noqa: E402
 from .member import Member  # noqa: E402

{python_easyverein-2.1.1 → python_easyverein-2.2.0}/easyverein/models/invoice_item.py

@@ -35,8 +35,7 @@ class InvoiceItemBase(EasyVereinBase):
     taxRate: float | None = None
     gross: bool | None = None
     taxName: str | None = None
-    # TODO: Add reference to BillingAccount once implemented
-    billingAccount: EasyVereinReference | None = None
+    billingAccount: BillingAccount | EasyVereinReference | None = None
     costCentre: Annotated[str, Field(max_length=8)] | None = None
 
 
@@ -85,4 +84,5 @@ class InvoiceItemFilter(BaseModel):
     search: str | None = None
 
 
+from .billing_account import BillingAccount  # noqa: E402
 from .invoice import Invoice  # noqa: E402

{python_easyverein-2.1.1 → python_easyverein-2.2.0}/easyverein/models/member.py

@@ -135,9 +135,9 @@ class MemberFilter(BaseModel):
     contactDetails__country: str | None = None
     membershipNumber: str | None = None
     membershipNumber__in: FilterStrList | None = None
-    deletedBy: int = Field(default=None, serialization_alias="_deletedBy")
-    deletedBy__ne: int = Field(default=None, serialization_alias="_deletedBy__ne")
-    deletedBy__isnull: bool = Field(default=None, serialization_alias="_deletedBy__isnull")
+    deletedBy: int | None = Field(default=None, serialization_alias="_deletedBy")
+    deletedBy__ne: int | None = Field(default=None, serialization_alias="_deletedBy__ne")
+    deletedBy__isnull: bool | None = Field(default=None, serialization_alias="_deletedBy__isnull")
     joinDate: DateTime | None = None
     joinDate__gte: DateTime | None = None
     joinDate__lte: DateTime | None = None
@@ -146,18 +146,22 @@ class MemberFilter(BaseModel):
     resignationDate__gte: DateTime | None = None
     resignationDate__lte: DateTime | None = None
     resignationDate__isnull: bool | None = None
-    isApplication: bool = Field(default=None, serialization_alias="_isApplication")
-    applicationDate: Date = Field(default=None, serialization_alias="_applicationDate")
-    applicationDate__gte: Date = Field(default=None, serialization_alias="_applicationDate__gte")
-    applicationDate__lte: Date = Field(default=None, serialization_alias="_applicationDate__lte")
-    applicationDate__isnull: bool = Field(default=None, serialization_alias="_applicationDate__isnull")
-    applicationWasAcceptedAt: Date = Field(default=None, serialization_alias="_applicationWasAcceptedAt")
-    applicationWasAcceptedAt__gte: Date = Field(default=None, serialization_alias="_applicationWasAcceptedAt__gte")
-    applicationWasAcceptedAt__lte: Date = Field(default=None, serialization_alias="_applicationWasAcceptedAt__lte")
-    applicationWasAcceptedAt__isnull: bool = Field(
+    isApplication: bool | None = Field(default=None, serialization_alias="_isApplication")
+    applicationDate: Date | None = Field(default=None, serialization_alias="_applicationDate")
+    applicationDate__gte: Date | None = Field(default=None, serialization_alias="_applicationDate__gte")
+    applicationDate__lte: Date | None = Field(default=None, serialization_alias="_applicationDate__lte")
+    applicationDate__isnull: bool | None = Field(default=None, serialization_alias="_applicationDate__isnull")
+    applicationWasAcceptedAt: Date | None = Field(default=None, serialization_alias="_applicationWasAcceptedAt")
+    applicationWasAcceptedAt__gte: Date | None = Field(
+        default=None, serialization_alias="_applicationWasAcceptedAt__gte"
+    )
+    applicationWasAcceptedAt__lte: Date | None = Field(
+        default=None, serialization_alias="_applicationWasAcceptedAt__lte"
+    )
+    applicationWasAcceptedAt__isnull: bool | None = Field(
         default=None, serialization_alias="_applicationWasAcceptedAt__isnull"
     )
-    isChairman: bool = Field(default=None, serialization_alias="_isChairman")
+    isChairman: bool | None = Field(default=None, serialization_alias="_isChairman")
     memberGroups: FilterIntList | None = None
     """
     Filter for members that are member of the given group(s)

{python_easyverein-2.1.1 → python_easyverein-2.2.0}/easyverein/models/member_group.py

@@ -48,7 +48,7 @@ class MemberGroupBase(EasyVereinBase):
     agePermission: PositiveIntWithZero | None = None
     nextGroup: EasyVereinReference | None = None
     taxRate: float | None = None
-    billingAccount: EasyVereinReference | None = None
+    billingAccount: BillingAccount | EasyVereinReference | None = None
     costCentre: str | None = Field(default=None, max_length=8)
     isOnlyVisibleToAdmins: bool | None = None
     user_shares: Literal["n", "a", "d"] | None = None
@@ -153,3 +153,6 @@ class MemberGroupFilter(BaseModel):
     kind: str | None = None
     deleted: bool | None = None
     ordering: str | None = None
+
+
+from .billing_account import BillingAccount  # noqa: E402

python_easyverein-2.2.0/easyverein/modules/billing_account.py

@@ -0,0 +1,27 @@
+"""
+All methods related to billing accounts
+"""
+
+import logging
+
+from ..core.client import EasyvereinClient
+from ..models.billing_account import (
+    BillingAccount,
+    BillingAccountCreate,
+    BillingAccountFilter,
+    BillingAccountUpdate,
+)
+from .mixins.crud import CRUDMixin
+from .mixins.recycle_bin import RecycleBinMixin
+
+
+class BillingAccountMixin(
+    CRUDMixin[BillingAccount, BillingAccountCreate, BillingAccountUpdate, BillingAccountFilter],
+    RecycleBinMixin[BillingAccount],
+):
+    def __init__(self, client: EasyvereinClient, logger: logging.Logger):
+        super().__init__()
+        self.endpoint_name = "billing-account"
+        self.return_type = BillingAccount
+        self.c = client
+        self.logger = logger

{python_easyverein-2.1.1 → python_easyverein-2.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "python-easyverein"
-version = "2.1.1"
+version = "2.2.0"
 description = "Python library to interact with the EasyVerein API"
 authors = ["Daniel Herrmann <daniel.herrmann1@gmail.com>"]
 readme = "README.md"