moolabs 0.3.0__py3-none-any.whl

moolabs/models/subscription_addon.py

@@ -0,0 +1,167 @@
+# coding: utf-8
+
+"""
+    Moolabs API
+
+    Unified Moolabs SDK. Capability-based public surface stitched from internal service specs: bff, meter, arc, acute. Customers see capability namespaces (usage, billing, collections, etc.); the SDK routes per-operation internally.
+
+    The version of the OpenAPI document: 0.3.0
+    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 moolabs.models.addon1 import Addon1
+from moolabs.models.subscription_addon_rate_card import SubscriptionAddonRateCard
+from moolabs.models.subscription_addon_timeline_segment import SubscriptionAddonTimelineSegment
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SubscriptionAddon(BaseModel):
+    """
+    A subscription add-on, represents concrete instances of an add-on for a given subscription.
+    """ # noqa: E501
+    id: Annotated[str, Field(strict=True)] = Field(description="A unique identifier for the resource.")
+    name: Annotated[str, Field(min_length=1, strict=True, max_length=256)] = Field(description="Human-readable name for the resource. Between 1 and 256 characters.")
+    description: Optional[Annotated[str, Field(strict=True, max_length=1024)]] = Field(default=None, description="Optional description of the resource. Maximum 1024 characters.")
+    metadata: Optional[Dict[str, StrictStr]] = Field(default=None, description="Additional metadata for the resource.")
+    created_at: datetime = Field(description="Timestamp of when the resource was created.", alias="createdAt")
+    updated_at: datetime = Field(description="Timestamp of when the resource was last updated.", alias="updatedAt")
+    deleted_at: Optional[datetime] = Field(default=None, description="Timestamp of when the resource was permanently deleted.", alias="deletedAt")
+    active_from: datetime = Field(description="The cadence start of the resource.", alias="activeFrom")
+    active_to: Optional[datetime] = Field(default=None, description="The cadence end of the resource.", alias="activeTo")
+    addon: Addon1
+    quantity_at: datetime = Field(description="For which point in time the quantity was resolved to.", alias="quantityAt")
+    quantity: Annotated[int, Field(strict=True, ge=0)] = Field(description="The quantity of the add-on. Always 1 for single instance add-ons.")
+    timeline: List[SubscriptionAddonTimelineSegment] = Field(description="The timeline of the add-on. The returned periods are sorted and continuous.")
+    subscription_id: Annotated[str, Field(strict=True)] = Field(description="The ID of the subscription.", alias="subscriptionId")
+    rate_cards: List[SubscriptionAddonRateCard] = Field(description="The rate cards of the add-on.", alias="rateCards")
+    __properties: ClassVar[List[str]] = ["id", "name", "description", "metadata", "createdAt", "updatedAt", "deletedAt", "activeFrom", "activeTo", "addon", "quantityAt", "quantity", "timeline", "subscriptionId", "rateCards"]
+
+    @field_validator('id')
+    def id_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$", value):
+            raise ValueError(r"must validate the regular expression /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/")
+        return value
+
+    @field_validator('subscription_id')
+    def subscription_id_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$", value):
+            raise ValueError(r"must validate the regular expression /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/")
+        return value
+
+    model_config = ConfigDict(
+        populate_by_name=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"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of SubscriptionAddon 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.
+        * OpenAPI `readOnly` fields are excluded.
+        """
+        excluded_fields: Set[str] = set([
+            "id",
+            "created_at",
+            "updated_at",
+            "deleted_at",
+            "active_from",
+            "active_to",
+            "quantity_at",
+            "subscription_id",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of addon
+        if self.addon:
+            _dict['addon'] = self.addon.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in timeline (list)
+        _items = []
+        if self.timeline:
+            for _item_timeline in self.timeline:
+                if _item_timeline:
+                    _items.append(_item_timeline.to_dict())
+            _dict['timeline'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in rate_cards (list)
+        _items = []
+        if self.rate_cards:
+            for _item_rate_cards in self.rate_cards:
+                if _item_rate_cards:
+                    _items.append(_item_rate_cards.to_dict())
+            _dict['rateCards'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SubscriptionAddon from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "name": obj.get("name"),
+            "description": obj.get("description"),
+            "metadata": obj.get("metadata"),
+            "createdAt": obj.get("createdAt"),
+            "updatedAt": obj.get("updatedAt"),
+            "deletedAt": obj.get("deletedAt"),
+            "activeFrom": obj.get("activeFrom"),
+            "activeTo": obj.get("activeTo"),
+            "addon": Addon1.from_dict(obj["addon"]) if obj.get("addon") is not None else None,
+            "quantityAt": obj.get("quantityAt"),
+            "quantity": obj.get("quantity"),
+            "timeline": [SubscriptionAddonTimelineSegment.from_dict(_item) for _item in obj["timeline"]] if obj.get("timeline") is not None else None,
+            "subscriptionId": obj.get("subscriptionId"),
+            "rateCards": [SubscriptionAddonRateCard.from_dict(_item) for _item in obj["rateCards"]] if obj.get("rateCards") is not None else None
+        })
+        return _obj
+
+

moolabs/models/subscription_addon_create.py

@@ -0,0 +1,106 @@
+# coding: utf-8
+
+"""
+    Moolabs API
+
+    Unified Moolabs SDK. Capability-based public surface stitched from internal service specs: bff, meter, arc, acute. Customers see capability namespaces (usage, billing, collections, etc.); the SDK routes per-operation internally.
+
+    The version of the OpenAPI document: 0.3.0
+    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 moolabs.models.addon2 import Addon2
+from moolabs.models.subscription_timing import SubscriptionTiming
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SubscriptionAddonCreate(BaseModel):
+    """
+    A subscription add-on create body.
+    """ # noqa: E501
+    name: Annotated[str, Field(min_length=1, strict=True, max_length=256)] = Field(description="Human-readable name for the resource. Between 1 and 256 characters.")
+    description: Optional[Annotated[str, Field(strict=True, max_length=1024)]] = Field(default=None, description="Optional description of the resource. Maximum 1024 characters.")
+    metadata: Optional[Dict[str, StrictStr]] = Field(default=None, description="Additional metadata for the resource.")
+    quantity: Annotated[int, Field(strict=True, ge=0)] = Field(description="The quantity of the add-on. Always 1 for single instance add-ons.")
+    timing: SubscriptionTiming = Field(description="The timing of the operation. After the create or update, a new entry will be created in the timeline.")
+    addon: Addon2
+    __properties: ClassVar[List[str]] = ["name", "description", "metadata", "quantity", "timing", "addon"]
+
+    model_config = ConfigDict(
+        populate_by_name=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"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of SubscriptionAddonCreate 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 timing
+        if self.timing:
+            _dict['timing'] = self.timing.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of addon
+        if self.addon:
+            _dict['addon'] = self.addon.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SubscriptionAddonCreate from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "name": obj.get("name"),
+            "description": obj.get("description"),
+            "metadata": obj.get("metadata"),
+            "quantity": obj.get("quantity"),
+            "timing": SubscriptionTiming.from_dict(obj["timing"]) if obj.get("timing") is not None else None,
+            "addon": Addon2.from_dict(obj["addon"]) if obj.get("addon") is not None else None
+        })
+        return _obj
+
+

moolabs/models/subscription_addon_rate_card.py

@@ -0,0 +1,94 @@
+# coding: utf-8
+
+"""
+    Moolabs API
+
+    Unified Moolabs SDK. Capability-based public surface stitched from internal service specs: bff, meter, arc, acute. Customers see capability namespaces (usage, billing, collections, etc.); the SDK routes per-operation internally.
+
+    The version of the OpenAPI document: 0.3.0
+    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, field_validator
+from typing import Any, ClassVar, Dict, List
+from typing_extensions import Annotated
+from moolabs.models.rate_card import RateCard
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SubscriptionAddonRateCard(BaseModel):
+    """
+    A rate card for a subscription add-on.
+    """ # noqa: E501
+    rate_card: RateCard = Field(description="The rate card.", alias="rateCard")
+    affected_subscription_item_ids: List[Annotated[str, Field(strict=True)]] = Field(description="The IDs of the subscription items that this rate card belongs to.", alias="affectedSubscriptionItemIds")
+    __properties: ClassVar[List[str]] = ["rateCard", "affectedSubscriptionItemIds"]
+
+    model_config = ConfigDict(
+        populate_by_name=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"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of SubscriptionAddonRateCard 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 rate_card
+        if self.rate_card:
+            _dict['rateCard'] = self.rate_card.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SubscriptionAddonRateCard from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "rateCard": RateCard.from_dict(obj["rateCard"]) if obj.get("rateCard") is not None else None,
+            "affectedSubscriptionItemIds": obj.get("affectedSubscriptionItemIds")
+        })
+        return _obj
+
+

moolabs/models/subscription_addon_timeline_segment.py

@@ -0,0 +1,95 @@
+# coding: utf-8
+
+"""
+    Moolabs API
+
+    Unified Moolabs SDK. Capability-based public surface stitched from internal service specs: bff, meter, arc, acute. Customers see capability namespaces (usage, billing, collections, etc.); the SDK routes per-operation internally.
+
+    The version of the OpenAPI document: 0.3.0
+    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
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SubscriptionAddonTimelineSegment(BaseModel):
+    """
+    A subscription add-on event.
+    """ # noqa: E501
+    active_from: datetime = Field(description="The cadence start of the resource.", alias="activeFrom")
+    active_to: Optional[datetime] = Field(default=None, description="The cadence end of the resource.", alias="activeTo")
+    quantity: Annotated[int, Field(strict=True, ge=0)] = Field(description="The quantity of the add-on for the given period.")
+    __properties: ClassVar[List[str]] = ["activeFrom", "activeTo", "quantity"]
+
+    model_config = ConfigDict(
+        populate_by_name=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"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of SubscriptionAddonTimelineSegment 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([
+            "quantity",
+        ])
+
+        _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 SubscriptionAddonTimelineSegment from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "activeFrom": obj.get("activeFrom"),
+            "activeTo": obj.get("activeTo"),
+            "quantity": obj.get("quantity")
+        })
+        return _obj
+
+

moolabs/models/subscription_addon_update.py

@@ -0,0 +1,100 @@
+# coding: utf-8
+
+"""
+    Moolabs API
+
+    Unified Moolabs SDK. Capability-based public surface stitched from internal service specs: bff, meter, arc, acute. Customers see capability namespaces (usage, billing, collections, etc.); the SDK routes per-operation internally.
+
+    The version of the OpenAPI document: 0.3.0
+    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 moolabs.models.subscription_timing import SubscriptionTiming
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SubscriptionAddonUpdate(BaseModel):
+    """
+    Resource create or update operation model.
+    """ # noqa: E501
+    name: Optional[Annotated[str, Field(min_length=1, strict=True, max_length=256)]] = Field(default=None, description="Human-readable name for the resource. Between 1 and 256 characters.")
+    description: Optional[Annotated[str, Field(strict=True, max_length=1024)]] = Field(default=None, description="Optional description of the resource. Maximum 1024 characters.")
+    metadata: Optional[Dict[str, StrictStr]] = Field(default=None, description="Additional metadata for the resource.")
+    quantity: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The quantity of the add-on. Always 1 for single instance add-ons.")
+    timing: Optional[SubscriptionTiming] = Field(default=None, description="The timing of the operation. After the create or update, a new entry will be created in the timeline.")
+    __properties: ClassVar[List[str]] = ["name", "description", "metadata", "quantity", "timing"]
+
+    model_config = ConfigDict(
+        populate_by_name=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"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of SubscriptionAddonUpdate 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 timing
+        if self.timing:
+            _dict['timing'] = self.timing.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SubscriptionAddonUpdate from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "name": obj.get("name"),
+            "description": obj.get("description"),
+            "metadata": obj.get("metadata"),
+            "quantity": obj.get("quantity"),
+            "timing": SubscriptionTiming.from_dict(obj["timing"]) if obj.get("timing") is not None else None
+        })
+        return _obj
+
+

moolabs/models/subscription_alignment.py

@@ -0,0 +1,93 @@
+# coding: utf-8
+
+"""
+    Moolabs API
+
+    Unified Moolabs SDK. Capability-based public surface stitched from internal service specs: bff, meter, arc, acute. Customers see capability namespaces (usage, billing, collections, etc.); the SDK routes per-operation internally.
+
+    The version of the OpenAPI document: 0.3.0
+    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
+from typing import Any, ClassVar, Dict, List, Optional
+from moolabs.models.period import Period
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SubscriptionAlignment(BaseModel):
+    """
+    Alignment details enriched with the current billing period.
+    """ # noqa: E501
+    billables_must_align: Optional[StrictBool] = Field(default=None, description="Whether all Billable items and RateCards must align. Alignment means the Price's BillingCadence must align for both duration and anchor time.", alias="billablesMustAlign")
+    current_aligned_billing_period: Optional[Period] = Field(default=None, description="The current billing period. Only has value if the subscription is aligned and active.", alias="currentAlignedBillingPeriod")
+    __properties: ClassVar[List[str]] = ["billablesMustAlign", "currentAlignedBillingPeriod"]
+
+    model_config = ConfigDict(
+        populate_by_name=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"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of SubscriptionAlignment 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 current_aligned_billing_period
+        if self.current_aligned_billing_period:
+            _dict['currentAlignedBillingPeriod'] = self.current_aligned_billing_period.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SubscriptionAlignment from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "billablesMustAlign": obj.get("billablesMustAlign"),
+            "currentAlignedBillingPeriod": Period.from_dict(obj["currentAlignedBillingPeriod"]) if obj.get("currentAlignedBillingPeriod") is not None else None
+        })
+        return _obj
+
+