moolabs 0.3.0__py3-none-any.whl

moolabs/models/plan_create_request.py

@@ -0,0 +1,103 @@
+# 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 date
+from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PlanCreateRequest(BaseModel):
+    """
+    PlanCreateRequest
+    """ # noqa: E501
+    total_amount_micros: Annotated[int, Field(strict=True, ge=1)]
+    installment_count: Annotated[int, Field(le=60, strict=True, ge=1)]
+    frequency: Optional[StrictStr] = 'monthly'
+    first_due_date: date
+    proposed_by: StrictStr
+    currency_code: Optional[StrictStr] = None
+    grace_period_days: Optional[StrictInt] = 3
+    max_missed_before_default: Optional[StrictInt] = 2
+    __properties: ClassVar[List[str]] = ["total_amount_micros", "installment_count", "frequency", "first_due_date", "proposed_by", "currency_code", "grace_period_days", "max_missed_before_default"]
+
+    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 PlanCreateRequest 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 PlanCreateRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "total_amount_micros": obj.get("total_amount_micros"),
+            "installment_count": obj.get("installment_count"),
+            "frequency": obj.get("frequency") if obj.get("frequency") is not None else 'monthly',
+            "first_due_date": obj.get("first_due_date"),
+            "proposed_by": obj.get("proposed_by"),
+            "currency_code": obj.get("currency_code"),
+            "grace_period_days": obj.get("grace_period_days") if obj.get("grace_period_days") is not None else 3,
+            "max_missed_before_default": obj.get("max_missed_before_default") if obj.get("max_missed_before_default") is not None else 2
+        })
+        return _obj
+
+

moolabs/models/plan_order_by.py

@@ -0,0 +1,40 @@
+# 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 json
+from enum import Enum
+from typing_extensions import Self
+
+
+class PlanOrderBy(str, Enum):
+    """
+    Order by options for plans.
+    """
+
+    """
+    allowed enum values
+    """
+    ID = 'id'
+    KEY = 'key'
+    VERSION = 'version'
+    CREATED_AT = 'created_at'
+    UPDATED_AT = 'updated_at'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of PlanOrderBy from a JSON string"""
+        return cls(json.loads(json_str))
+
+

moolabs/models/plan_paginated_response.py

@@ -0,0 +1,101 @@
+# 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, StrictInt
+from typing import Any, ClassVar, Dict, List
+from moolabs.models.plan import Plan
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PlanPaginatedResponse(BaseModel):
+    """
+    Paginated response
+    """ # noqa: E501
+    total_count: StrictInt = Field(description="The total number of items.", alias="totalCount")
+    page: StrictInt = Field(description="The page index.")
+    page_size: StrictInt = Field(description="The maximum number of items per page.", alias="pageSize")
+    items: List[Plan] = Field(description="The items in the current page.")
+    __properties: ClassVar[List[str]] = ["totalCount", "page", "pageSize", "items"]
+
+    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 PlanPaginatedResponse 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 items (list)
+        _items = []
+        if self.items:
+            for _item_items in self.items:
+                if _item_items:
+                    _items.append(_item_items.to_dict())
+            _dict['items'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PlanPaginatedResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "totalCount": obj.get("totalCount"),
+            "page": obj.get("page"),
+            "pageSize": obj.get("pageSize"),
+            "items": [Plan.from_dict(_item) for _item in obj["items"]] if obj.get("items") is not None else None
+        })
+        return _obj
+
+

moolabs/models/plan_phase.py

@@ -0,0 +1,113 @@
+# 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, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from moolabs.models.rate_card import RateCard
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PlanPhase(BaseModel):
+    """
+    The plan phase or pricing ramp allows changing a plan's rate cards over time as a subscription progresses.
+    """ # noqa: E501
+    key: Annotated[str, Field(min_length=1, strict=True, max_length=64)] = Field(description="A semi-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.")
+    duration: StrictStr = Field(description="The duration of the phase.")
+    rate_cards: List[RateCard] = Field(description="The rate cards of the plan.", alias="rateCards")
+    __properties: ClassVar[List[str]] = ["key", "name", "description", "metadata", "duration", "rateCards"]
+
+    @field_validator('key')
+    def key_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^[a-z0-9]+(?:_[a-z0-9]+)*$", value):
+            raise ValueError(r"must validate the regular expression /^[a-z0-9]+(?:_[a-z0-9]+)*$/")
+        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 PlanPhase 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 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 PlanPhase from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "key": obj.get("key"),
+            "name": obj.get("name"),
+            "description": obj.get("description"),
+            "metadata": obj.get("metadata"),
+            "duration": obj.get("duration"),
+            "rateCards": [RateCard.from_dict(_item) for _item in obj["rateCards"]] if obj.get("rateCards") is not None else None
+        })
+        return _obj
+
+

moolabs/models/plan_pricing_input.py

@@ -0,0 +1,103 @@
+# 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
+from typing import Any, ClassVar, Dict, List, Optional
+from moolabs.models.commercial_basis import CommercialBasis
+from moolabs.models.feature_pricing_input import FeaturePricingInput
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PlanPricingInput(BaseModel):
+    """
+    The ``pricing`` payload: a map of ``featureKey -> FeaturePricingInput`` + basis.
+    """ # noqa: E501
+    commercial_basis: Optional[CommercialBasis] = Field(default=None, alias="commercialBasis")
+    pricing: Optional[Dict[str, FeaturePricingInput]] = None
+    __properties: ClassVar[List[str]] = ["commercialBasis", "pricing"]
+
+    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 PlanPricingInput 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 value in pricing (dict)
+        _field_dict = {}
+        if self.pricing:
+            for _key_pricing in self.pricing:
+                if self.pricing[_key_pricing]:
+                    _field_dict[_key_pricing] = self.pricing[_key_pricing].to_dict()
+            _dict['pricing'] = _field_dict
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PlanPricingInput from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "commercialBasis": obj.get("commercialBasis"),
+            "pricing": dict(
+                (_k, FeaturePricingInput.from_dict(_v))
+                for _k, _v in obj["pricing"].items()
+            )
+            if obj.get("pricing") is not None
+            else None
+        })
+        return _obj
+
+

moolabs/models/plan_pricing_sync_request.py

@@ -0,0 +1,105 @@
+# 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, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PlanPricingSyncRequest(BaseModel):
+    """
+    PlanPricingSyncRequest
+    """ # noqa: E501
+    tenant_id: StrictStr
+    operation: StrictStr
+    plan_id: StrictStr
+    plan: Optional[Dict[str, Any]] = None
+    effective_at: Optional[datetime] = None
+    pricing_shape: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["tenant_id", "operation", "plan_id", "plan", "effective_at", "pricing_shape"]
+
+    @field_validator('operation')
+    def operation_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['publish', 'archive']):
+            raise ValueError("must be one of enum values ('publish', 'archive')")
+        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 PlanPricingSyncRequest 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 PlanPricingSyncRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "tenant_id": obj.get("tenant_id"),
+            "operation": obj.get("operation"),
+            "plan_id": obj.get("plan_id"),
+            "plan": obj.get("plan"),
+            "effective_at": obj.get("effective_at"),
+            "pricing_shape": obj.get("pricing_shape")
+        })
+        return _obj
+
+

moolabs/models/plan_pricing_view.py

@@ -0,0 +1,107 @@
+# 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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from moolabs.models.commercial_basis import CommercialBasis
+from moolabs.models.feature_pricing_input import FeaturePricingInput
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PlanPricingView(BaseModel):
+    """
+    Re-hydration payload for ``GET /v1/plans/{key}/pricing`` (US-009).  Echoes the authored plan pricing back so the plan builder can render Step 2 identically to create: the per-feature ``FeaturePricingInput`` map (``model`` / ``baseRateMicros`` / ``tiers`` / ``overrides``) plus the effective ``planVersion`` (the major ``M``) and ``rateMinor`` (the effective minor ``m``). Reconstructed from the persisted ``unified_price_rows`` (base + override), NOT the draft ``saga_payload`` (which is cleared on publish).
+    """ # noqa: E501
+    plan_version: StrictStr = Field(alias="planVersion")
+    rate_minor: StrictInt = Field(alias="rateMinor")
+    commercial_basis: Optional[CommercialBasis] = Field(default=None, alias="commercialBasis")
+    pricing: Optional[Dict[str, FeaturePricingInput]] = None
+    __properties: ClassVar[List[str]] = ["planVersion", "rateMinor", "commercialBasis", "pricing"]
+
+    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 PlanPricingView 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 value in pricing (dict)
+        _field_dict = {}
+        if self.pricing:
+            for _key_pricing in self.pricing:
+                if self.pricing[_key_pricing]:
+                    _field_dict[_key_pricing] = self.pricing[_key_pricing].to_dict()
+            _dict['pricing'] = _field_dict
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PlanPricingView from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "planVersion": obj.get("planVersion"),
+            "rateMinor": obj.get("rateMinor"),
+            "commercialBasis": obj.get("commercialBasis"),
+            "pricing": dict(
+                (_k, FeaturePricingInput.from_dict(_v))
+                for _k, _v in obj["pricing"].items()
+            )
+            if obj.get("pricing") is not None
+            else None
+        })
+        return _obj
+
+