solvimon-python-sdk 0.0.4b0__py3-none-any.whl

solvimon_python_sdk/models/usage_trigger.py

@@ -0,0 +1,97 @@
+# coding: utf-8
+
+"""
+    Solvimon API
+
+    Unified Solvimon API covering Configuration, Event, Identity, and Transaction domains.
+
+    The version of the OpenAPI document: 0.0.4-beta
+    Contact: contact@solvimon.com
+    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 solvimon_python_sdk.models.usage_trigger_event import UsageTriggerEvent
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class UsageTrigger(BaseModel):
+    """
+    Stores the usage reference and execution details used when a workflow runs for a usage event.
+    """ # noqa: E501
+    meter_value_calculation_id: Optional[StrictStr] = Field(default=None, description="Meter value calculation that the workflow execution runs for.")
+    event: Optional[UsageTriggerEvent] = Field(default=None, description="Event details recorded for usage executions created from system activity.")
+    __properties: ClassVar[List[str]] = ["meter_value_calculation_id", "event"]
+
+    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 UsageTrigger 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([
+            "event",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of event
+        if self.event:
+            _dict['event'] = self.event.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of UsageTrigger from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "meter_value_calculation_id": obj.get("meter_value_calculation_id"),
+            "event": UsageTriggerEvent.from_dict(obj["event"]) if obj.get("event") is not None else None
+        })
+        return _obj
+
+

solvimon_python_sdk/models/usage_trigger_create_request.py

@@ -0,0 +1,97 @@
+# coding: utf-8
+
+"""
+    Solvimon API
+
+    Unified Solvimon API covering Configuration, Event, Identity, and Transaction domains.
+
+    The version of the OpenAPI document: 0.0.4-beta
+    Contact: contact@solvimon.com
+    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 solvimon_python_sdk.models.usage_trigger_event import UsageTriggerEvent
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class UsageTriggerCreateRequest(BaseModel):
+    """
+    Stores the usage reference and execution details used when a workflow runs for a usage event.
+    """ # noqa: E501
+    meter_value_calculation_id: Optional[StrictStr] = Field(default=None, description="Meter value calculation that the workflow execution runs for.")
+    event: Optional[UsageTriggerEvent] = Field(default=None, description="Event details recorded for usage executions created from system activity.")
+    __properties: ClassVar[List[str]] = ["meter_value_calculation_id", "event"]
+
+    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 UsageTriggerCreateRequest 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([
+            "event",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of event
+        if self.event:
+            _dict['event'] = self.event.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of UsageTriggerCreateRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "meter_value_calculation_id": obj.get("meter_value_calculation_id"),
+            "event": UsageTriggerEvent.from_dict(obj["event"]) if obj.get("event") is not None else None
+        })
+        return _obj
+
+

solvimon_python_sdk/models/usage_trigger_event.py

@@ -0,0 +1,131 @@
+# coding: utf-8
+
+"""
+    Solvimon API
+
+    Unified Solvimon API covering Configuration, Event, Identity, and Transaction domains.
+
+    The version of the OpenAPI document: 0.0.4-beta
+    Contact: contact@solvimon.com
+    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 UsageTriggerEvent(BaseModel):
+    """
+    Defines event details captured for usage workflow triggers.
+    """ # noqa: E501
+    variant: Optional[StrictStr] = Field(default=None, description="Usage workflow variant used for the execution.")
+    customer_id: Optional[StrictStr] = Field(default=None, description="Customer whose consumption crossed the threshold.")
+    parent_customer_id: Optional[StrictStr] = Field(default=None, description="Parent customer whose CHILDREN limit governed the crossing; omitted for a customer's own SELF limit.")
+    threshold: Optional[StrictStr] = Field(default=None, description="Threshold value that was crossed.")
+    threshold_type: Optional[StrictStr] = Field(default=None, description="Configured kind of the crossed threshold: PERCENTAGE, NUMBER, AMOUNT, or CREDITS.")
+    limit: Optional[StrictStr] = Field(default=None, description="Resolved limit value the threshold was derived from.")
+    consumed: Optional[StrictStr] = Field(default=None, description="Period-to-date consumption at the moment of the crossing.")
+    period_start: Optional[StrictStr] = Field(default=None, description="Start of the billing period the consumption was accumulated over.")
+    period_end: Optional[StrictStr] = Field(default=None, description="End of the billing period the consumption was accumulated over.")
+    __properties: ClassVar[List[str]] = ["variant", "customer_id", "parent_customer_id", "threshold", "threshold_type", "limit", "consumed", "period_start", "period_end"]
+
+    @field_validator('variant')
+    def variant_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['USAGE_LIMIT']):
+            raise ValueError("must be one of enum values ('USAGE_LIMIT')")
+        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 UsageTriggerEvent 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([
+            "customer_id",
+            "parent_customer_id",
+            "threshold",
+            "threshold_type",
+            "limit",
+            "consumed",
+            "period_start",
+            "period_end",
+        ])
+
+        _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 UsageTriggerEvent from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "variant": obj.get("variant"),
+            "customer_id": obj.get("customer_id"),
+            "parent_customer_id": obj.get("parent_customer_id"),
+            "threshold": obj.get("threshold"),
+            "threshold_type": obj.get("threshold_type"),
+            "limit": obj.get("limit"),
+            "consumed": obj.get("consumed"),
+            "period_start": obj.get("period_start"),
+            "period_end": obj.get("period_end")
+        })
+        return _obj
+
+

solvimon_python_sdk/models/usage_workflow.py

@@ -0,0 +1,110 @@
+# coding: utf-8
+
+"""
+    Solvimon API
+
+    Unified Solvimon API covering Configuration, Event, Identity, and Transaction domains.
+
+    The version of the OpenAPI document: 0.0.4-beta
+    Contact: contact@solvimon.com
+    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 solvimon_python_sdk.models.usage_threshold import UsageThreshold
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class UsageWorkflow(BaseModel):
+    """
+    Defines the usage-specific workflow settings that determine when usage workflows should run.
+    """ # noqa: E501
+    variant: Optional[StrictStr] = Field(default=None, description="Usage workflow variant that determines which usage condition starts the workflow.")
+    meter_value_calculation_id: Optional[StrictStr] = Field(default=None, description="Meter value calculation the usage is measured against.")
+    thresholds: Optional[List[UsageThreshold]] = Field(default=None, description="Thresholds that trigger the workflow. Each threshold sets exactly one of percentage, number, amount, or credits.")
+    __properties: ClassVar[List[str]] = ["variant", "meter_value_calculation_id", "thresholds"]
+
+    @field_validator('variant')
+    def variant_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['USAGE_LIMIT']):
+            raise ValueError("must be one of enum values ('USAGE_LIMIT')")
+        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 UsageWorkflow 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 thresholds (list)
+        _items = []
+        if self.thresholds:
+            for _item_thresholds in self.thresholds:
+                _items.append(_item_thresholds.to_dict() if _item_thresholds is not None else None)
+            _dict['thresholds'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of UsageWorkflow from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "variant": obj.get("variant"),
+            "meter_value_calculation_id": obj.get("meter_value_calculation_id"),
+            "thresholds": [UsageThreshold.from_dict(_item) for _item in obj["thresholds"]] if obj.get("thresholds") is not None else None
+        })
+        return _obj
+
+

solvimon_python_sdk/models/usage_workflow_create_request.py

@@ -0,0 +1,110 @@
+# coding: utf-8
+
+"""
+    Solvimon API
+
+    Unified Solvimon API covering Configuration, Event, Identity, and Transaction domains.
+
+    The version of the OpenAPI document: 0.0.4-beta
+    Contact: contact@solvimon.com
+    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 solvimon_python_sdk.models.usage_threshold import UsageThreshold
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class UsageWorkflowCreateRequest(BaseModel):
+    """
+    Defines the usage-specific workflow settings that determine when usage workflows should run.
+    """ # noqa: E501
+    variant: Optional[StrictStr] = Field(default=None, description="Usage workflow variant that determines which usage condition starts the workflow.")
+    meter_value_calculation_id: Optional[StrictStr] = Field(default=None, description="Meter value calculation the usage is measured against.")
+    thresholds: Optional[List[UsageThreshold]] = Field(default=None, description="Thresholds that trigger the workflow. Each threshold sets exactly one of percentage, number, amount, or credits.")
+    __properties: ClassVar[List[str]] = ["variant", "meter_value_calculation_id", "thresholds"]
+
+    @field_validator('variant')
+    def variant_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['USAGE_LIMIT']):
+            raise ValueError("must be one of enum values ('USAGE_LIMIT')")
+        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 UsageWorkflowCreateRequest 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 thresholds (list)
+        _items = []
+        if self.thresholds:
+            for _item_thresholds in self.thresholds:
+                _items.append(_item_thresholds.to_dict() if _item_thresholds is not None else None)
+            _dict['thresholds'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of UsageWorkflowCreateRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "variant": obj.get("variant"),
+            "meter_value_calculation_id": obj.get("meter_value_calculation_id"),
+            "thresholds": [UsageThreshold.from_dict(_item) for _item in obj["thresholds"]] if obj.get("thresholds") is not None else None
+        })
+        return _obj
+
+

solvimon_python_sdk/models/usage_workflow_update_request.py

@@ -0,0 +1,110 @@
+# coding: utf-8
+
+"""
+    Solvimon API
+
+    Unified Solvimon API covering Configuration, Event, Identity, and Transaction domains.
+
+    The version of the OpenAPI document: 0.0.4-beta
+    Contact: contact@solvimon.com
+    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 solvimon_python_sdk.models.usage_threshold import UsageThreshold
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class UsageWorkflowUpdateRequest(BaseModel):
+    """
+    Defines the usage-specific workflow settings that determine when usage workflows should run.
+    """ # noqa: E501
+    variant: Optional[StrictStr] = Field(default=None, description="Usage workflow variant that determines which usage condition starts the workflow.")
+    meter_value_calculation_id: Optional[StrictStr] = Field(default=None, description="Meter value calculation the usage is measured against.")
+    thresholds: Optional[List[UsageThreshold]] = Field(default=None, description="Thresholds that trigger the workflow. Each threshold sets exactly one of percentage, number, amount, or credits.")
+    __properties: ClassVar[List[str]] = ["variant", "meter_value_calculation_id", "thresholds"]
+
+    @field_validator('variant')
+    def variant_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['USAGE_LIMIT']):
+            raise ValueError("must be one of enum values ('USAGE_LIMIT')")
+        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 UsageWorkflowUpdateRequest 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 thresholds (list)
+        _items = []
+        if self.thresholds:
+            for _item_thresholds in self.thresholds:
+                _items.append(_item_thresholds.to_dict() if _item_thresholds is not None else None)
+            _dict['thresholds'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of UsageWorkflowUpdateRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "variant": obj.get("variant"),
+            "meter_value_calculation_id": obj.get("meter_value_calculation_id"),
+            "thresholds": [UsageThreshold.from_dict(_item) for _item in obj["thresholds"]] if obj.get("thresholds") is not None else None
+        })
+        return _obj
+
+