api-sdk-py 1.11.66__py3-none-any.whl

api_sdk_py/models/partner_analytics_by_managed_user.py

@@ -0,0 +1,109 @@
+# coding: utf-8
+
+"""
+    Widgetic API Gateway
+
+    API documentation for the Widgetic API Gateway
+
+    The version of the OpenAPI document: 1.0.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
+from api_sdk_py.models.partner_analytics_of_managed_user import PartnerAnalyticsOfManagedUser
+from api_sdk_py.models.partner_report_page import PartnerReportPage
+from api_sdk_py.models.partner_report_period import PartnerReportPeriod
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PartnerAnalyticsByManagedUser(BaseModel):
+    """
+    What each of the partner's managed users did in a period. Every managed user of the partner is listed, also one whose widgets were not viewed, the most viewed first. 
+    """ # noqa: E501
+    partner_id: StrictStr = Field(alias="partnerId")
+    period: PartnerReportPeriod
+    managed_users: List[PartnerAnalyticsOfManagedUser] = Field(alias="managedUsers")
+    page: PartnerReportPage
+    __properties: ClassVar[List[str]] = ["partnerId", "period", "managedUsers", "page"]
+
+    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 PartnerAnalyticsByManagedUser 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 period
+        if self.period:
+            _dict['period'] = self.period.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in managed_users (list)
+        _items = []
+        if self.managed_users:
+            for _item_managed_users in self.managed_users:
+                if _item_managed_users:
+                    _items.append(_item_managed_users.to_dict())
+            _dict['managedUsers'] = _items
+        # override the default output from pydantic by calling `to_dict()` of page
+        if self.page:
+            _dict['page'] = self.page.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PartnerAnalyticsByManagedUser from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "partnerId": obj.get("partnerId"),
+            "period": PartnerReportPeriod.from_dict(obj["period"]) if obj.get("period") is not None else None,
+            "managedUsers": [PartnerAnalyticsOfManagedUser.from_dict(_item) for _item in obj["managedUsers"]] if obj.get("managedUsers") is not None else None,
+            "page": PartnerReportPage.from_dict(obj["page"]) if obj.get("page") is not None else None
+        })
+        return _obj
+
+

api_sdk_py/models/partner_analytics_by_managed_user_response.py

@@ -0,0 +1,99 @@
+# coding: utf-8
+
+"""
+    Widgetic API Gateway
+
+    API documentation for the Widgetic API Gateway
+
+    The version of the OpenAPI document: 1.0.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 api_sdk_py.models.partner_analytics_by_managed_user import PartnerAnalyticsByManagedUser
+from api_sdk_py.models.response_meta import ResponseMeta
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PartnerAnalyticsByManagedUserResponse(BaseModel):
+    """
+    PartnerAnalyticsByManagedUserResponse
+    """ # noqa: E501
+    success: StrictBool = Field(description="Always `true` on a success.")
+    data: PartnerAnalyticsByManagedUser
+    meta: Optional[ResponseMeta] = None
+    __properties: ClassVar[List[str]] = ["success", "data", "meta"]
+
+    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 PartnerAnalyticsByManagedUserResponse 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 data
+        if self.data:
+            _dict['data'] = self.data.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of meta
+        if self.meta:
+            _dict['meta'] = self.meta.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PartnerAnalyticsByManagedUserResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "success": obj.get("success"),
+            "data": PartnerAnalyticsByManagedUser.from_dict(obj["data"]) if obj.get("data") is not None else None,
+            "meta": ResponseMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None
+        })
+        return _obj
+
+

api_sdk_py/models/partner_analytics_of_day.py

@@ -0,0 +1,94 @@
+# coding: utf-8
+
+"""
+    Widgetic API Gateway
+
+    API documentation for the Widgetic API Gateway
+
+    The version of the OpenAPI document: 1.0.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
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PartnerAnalyticsOfDay(BaseModel):
+    """
+    What was done on one day (UTC).
+    """ # noqa: E501
+    var_date: date = Field(alias="date")
+    views: StrictInt
+    interactions: StrictInt
+    visitors: StrictInt
+    __properties: ClassVar[List[str]] = ["date", "views", "interactions", "visitors"]
+
+    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 PartnerAnalyticsOfDay 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 PartnerAnalyticsOfDay from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "date": obj.get("date"),
+            "views": obj.get("views"),
+            "interactions": obj.get("interactions"),
+            "visitors": obj.get("visitors")
+        })
+        return _obj
+
+

api_sdk_py/models/partner_analytics_of_managed_user.py

@@ -0,0 +1,126 @@
+# coding: utf-8
+
+"""
+    Widgetic API Gateway
+
+    API documentation for the Widgetic API Gateway
+
+    The version of the OpenAPI document: 1.0.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, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PartnerAnalyticsOfManagedUser(BaseModel):
+    """
+    What one managed user's widgets and compositions did in a period.
+    """ # noqa: E501
+    managed_user_id: StrictStr = Field(alias="managedUserId")
+    external_id: Optional[StrictStr] = Field(description="Your own identifier for the managed user", alias="externalId")
+    name: Optional[StrictStr]
+    is_active: Optional[StrictBool] = Field(alias="isActive")
+    widgets_made: StrictInt = Field(description="How many widgets are filed under the managed user (all time, not only in the period)", alias="widgetsMade")
+    compositions_made: StrictInt = Field(description="How many compositions are filed under the managed user (all time, not only in the period)", alias="compositionsMade")
+    views: StrictInt
+    interactions: StrictInt
+    visitors: StrictInt
+    last_event_at: Optional[datetime] = Field(description="When the newest counted view or interaction happened. Null when there was none in the period.", alias="lastEventAt")
+    __properties: ClassVar[List[str]] = ["managedUserId", "externalId", "name", "isActive", "widgetsMade", "compositionsMade", "views", "interactions", "visitors", "lastEventAt"]
+
+    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 PartnerAnalyticsOfManagedUser 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,
+        )
+        # set to None if external_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.external_id is None and "external_id" in self.model_fields_set:
+            _dict['externalId'] = None
+
+        # set to None if name (nullable) is None
+        # and model_fields_set contains the field
+        if self.name is None and "name" in self.model_fields_set:
+            _dict['name'] = None
+
+        # set to None if is_active (nullable) is None
+        # and model_fields_set contains the field
+        if self.is_active is None and "is_active" in self.model_fields_set:
+            _dict['isActive'] = None
+
+        # set to None if last_event_at (nullable) is None
+        # and model_fields_set contains the field
+        if self.last_event_at is None and "last_event_at" in self.model_fields_set:
+            _dict['lastEventAt'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PartnerAnalyticsOfManagedUser from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "managedUserId": obj.get("managedUserId"),
+            "externalId": obj.get("externalId"),
+            "name": obj.get("name"),
+            "isActive": obj.get("isActive"),
+            "widgetsMade": obj.get("widgetsMade"),
+            "compositionsMade": obj.get("compositionsMade"),
+            "views": obj.get("views"),
+            "interactions": obj.get("interactions"),
+            "visitors": obj.get("visitors"),
+            "lastEventAt": obj.get("lastEventAt")
+        })
+        return _obj
+
+

api_sdk_py/models/partner_analytics_of_widget.py

@@ -0,0 +1,102 @@
+# coding: utf-8
+
+"""
+    Widgetic API Gateway
+
+    API documentation for the Widgetic API Gateway
+
+    The version of the OpenAPI document: 1.0.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 typing import Optional, Set
+from typing_extensions import Self
+
+class PartnerAnalyticsOfWidget(BaseModel):
+    """
+    What one widget's compositions did in a period.
+    """ # noqa: E501
+    widget_id: StrictStr = Field(alias="widgetId")
+    widget_name: Optional[StrictStr] = Field(description="Null when the widget has been deleted since", alias="widgetName")
+    views: StrictInt
+    interactions: StrictInt
+    visitors: StrictInt
+    compositions_viewed: StrictInt = Field(description="How many different compositions of the widget were viewed", alias="compositionsViewed")
+    __properties: ClassVar[List[str]] = ["widgetId", "widgetName", "views", "interactions", "visitors", "compositionsViewed"]
+
+    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 PartnerAnalyticsOfWidget 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,
+        )
+        # set to None if widget_name (nullable) is None
+        # and model_fields_set contains the field
+        if self.widget_name is None and "widget_name" in self.model_fields_set:
+            _dict['widgetName'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PartnerAnalyticsOfWidget from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "widgetId": obj.get("widgetId"),
+            "widgetName": obj.get("widgetName"),
+            "views": obj.get("views"),
+            "interactions": obj.get("interactions"),
+            "visitors": obj.get("visitors"),
+            "compositionsViewed": obj.get("compositionsViewed")
+        })
+        return _obj
+
+

api_sdk_py/models/partner_analytics_summary.py

@@ -0,0 +1,110 @@
+# coding: utf-8
+
+"""
+    Widgetic API Gateway
+
+    API documentation for the Widgetic API Gateway
+
+    The version of the OpenAPI document: 1.0.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 api_sdk_py.models.partner_report_period import PartnerReportPeriod
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PartnerAnalyticsSummary(BaseModel):
+    """
+    What was done with the partner's published widgets in a period.
+    """ # noqa: E501
+    partner_id: StrictStr = Field(alias="partnerId")
+    period: PartnerReportPeriod
+    managed_user_id: Optional[StrictStr] = Field(description="The managed user the report is narrowed to. Null for the whole account.", alias="managedUserId")
+    views: StrictInt = Field(description="How many times a composition was shown to a visitor")
+    interactions: StrictInt = Field(description="How many times a visitor did something with a composition")
+    visitors: StrictInt = Field(description="How many different visitors viewed. A visitor is a browsing session; an event that carries no session is counted for the signed-in user instead. An event that carries neither is a view and no visitor. ")
+    compositions_viewed: StrictInt = Field(description="How many different compositions were viewed", alias="compositionsViewed")
+    managed_users_viewed: StrictInt = Field(description="How many different managed users had a composition viewed", alias="managedUsersViewed")
+    __properties: ClassVar[List[str]] = ["partnerId", "period", "managedUserId", "views", "interactions", "visitors", "compositionsViewed", "managedUsersViewed"]
+
+    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 PartnerAnalyticsSummary 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 period
+        if self.period:
+            _dict['period'] = self.period.to_dict()
+        # set to None if managed_user_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.managed_user_id is None and "managed_user_id" in self.model_fields_set:
+            _dict['managedUserId'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PartnerAnalyticsSummary from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "partnerId": obj.get("partnerId"),
+            "period": PartnerReportPeriod.from_dict(obj["period"]) if obj.get("period") is not None else None,
+            "managedUserId": obj.get("managedUserId"),
+            "views": obj.get("views"),
+            "interactions": obj.get("interactions"),
+            "visitors": obj.get("visitors"),
+            "compositionsViewed": obj.get("compositionsViewed"),
+            "managedUsersViewed": obj.get("managedUsersViewed")
+        })
+        return _obj
+
+