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

api_sdk_py/models/partner_notification_settings.py

@@ -0,0 +1,139 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from api_sdk_py.models.partner_notification_default_recipients import PartnerNotificationDefaultRecipients
+from api_sdk_py.models.partner_notification_event import PartnerNotificationEvent
+from api_sdk_py.models.partner_notification_event_type import PartnerNotificationEventType
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PartnerNotificationSettings(BaseModel):
+    """
+    Where your notifications go. The secret that signs your webhook is never part of it.
+    """ # noqa: E501
+    partner_id: StrictStr = Field(alias="partnerId")
+    email_recipients: List[StrictStr] = Field(description="The addresses the emails go to. Empty means the defaults.", alias="emailRecipients")
+    default_email_recipients: PartnerNotificationDefaultRecipients = Field(alias="defaultEmailRecipients")
+    email_events: Optional[List[PartnerNotificationEventType]] = Field(description="The events you want by email. Null means every event. The events marked `alwaysEmailed` are emailed whatever it says.", alias="emailEvents")
+    webhook_url: Optional[StrictStr] = Field(description="Where Widgetic sends a signed call for each event. Null while the webhook is switched off.", alias="webhookUrl")
+    webhook_events: Optional[List[PartnerNotificationEventType]] = Field(description="The events sent to your webhook. Null means every event.", alias="webhookEvents")
+    webhook_secret_set: StrictBool = Field(description="Whether a signing secret exists. Calls are made only when it does.", alias="webhookSecretSet")
+    webhook_secret_rotated_at: Optional[datetime] = Field(description="When the current secret was made", alias="webhookSecretRotatedAt")
+    webhook_signing_available: StrictBool = Field(description="False when this server cannot sign webhooks, in which case a webhook cannot be set up yet", alias="webhookSigningAvailable")
+    events: List[PartnerNotificationEvent] = Field(description="Every event there is, for a settings screen to list")
+    __properties: ClassVar[List[str]] = ["partnerId", "emailRecipients", "defaultEmailRecipients", "emailEvents", "webhookUrl", "webhookEvents", "webhookSecretSet", "webhookSecretRotatedAt", "webhookSigningAvailable", "events"]
+
+    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 PartnerNotificationSettings 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 default_email_recipients
+        if self.default_email_recipients:
+            _dict['defaultEmailRecipients'] = self.default_email_recipients.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in events (list)
+        _items = []
+        if self.events:
+            for _item_events in self.events:
+                if _item_events:
+                    _items.append(_item_events.to_dict())
+            _dict['events'] = _items
+        # set to None if email_events (nullable) is None
+        # and model_fields_set contains the field
+        if self.email_events is None and "email_events" in self.model_fields_set:
+            _dict['emailEvents'] = None
+
+        # set to None if webhook_url (nullable) is None
+        # and model_fields_set contains the field
+        if self.webhook_url is None and "webhook_url" in self.model_fields_set:
+            _dict['webhookUrl'] = None
+
+        # set to None if webhook_events (nullable) is None
+        # and model_fields_set contains the field
+        if self.webhook_events is None and "webhook_events" in self.model_fields_set:
+            _dict['webhookEvents'] = None
+
+        # set to None if webhook_secret_rotated_at (nullable) is None
+        # and model_fields_set contains the field
+        if self.webhook_secret_rotated_at is None and "webhook_secret_rotated_at" in self.model_fields_set:
+            _dict['webhookSecretRotatedAt'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PartnerNotificationSettings 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"),
+            "emailRecipients": obj.get("emailRecipients"),
+            "defaultEmailRecipients": PartnerNotificationDefaultRecipients.from_dict(obj["defaultEmailRecipients"]) if obj.get("defaultEmailRecipients") is not None else None,
+            "emailEvents": obj.get("emailEvents"),
+            "webhookUrl": obj.get("webhookUrl"),
+            "webhookEvents": obj.get("webhookEvents"),
+            "webhookSecretSet": obj.get("webhookSecretSet"),
+            "webhookSecretRotatedAt": obj.get("webhookSecretRotatedAt"),
+            "webhookSigningAvailable": obj.get("webhookSigningAvailable"),
+            "events": [PartnerNotificationEvent.from_dict(_item) for _item in obj["events"]] if obj.get("events") is not None else None
+        })
+        return _obj
+
+

api_sdk_py/models/partner_notification_settings_change.py

@@ -0,0 +1,98 @@
+# 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, Optional
+from api_sdk_py.models.partner_notification_settings import PartnerNotificationSettings
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PartnerNotificationSettingsChange(BaseModel):
+    """
+    The settings after a change, and the new signing secret when one was made.
+    """ # noqa: E501
+    settings: PartnerNotificationSettings
+    webhook_secret: Optional[StrictStr] = Field(description="The secret that signs your webhook, in the form your receiver is configured with (`whsec_...`). It is in this answer ONLY: keep it now, it cannot be read again. Null when the change made no secret.", alias="webhookSecret")
+    __properties: ClassVar[List[str]] = ["settings", "webhookSecret"]
+
+    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 PartnerNotificationSettingsChange 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 settings
+        if self.settings:
+            _dict['settings'] = self.settings.to_dict()
+        # set to None if webhook_secret (nullable) is None
+        # and model_fields_set contains the field
+        if self.webhook_secret is None and "webhook_secret" in self.model_fields_set:
+            _dict['webhookSecret'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PartnerNotificationSettingsChange from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "settings": PartnerNotificationSettings.from_dict(obj["settings"]) if obj.get("settings") is not None else None,
+            "webhookSecret": obj.get("webhookSecret")
+        })
+        return _obj
+
+

api_sdk_py/models/partner_notification_settings_change_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_notification_settings_change import PartnerNotificationSettingsChange
+from api_sdk_py.models.response_meta import ResponseMeta
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PartnerNotificationSettingsChangeResponse(BaseModel):
+    """
+    PartnerNotificationSettingsChangeResponse
+    """ # noqa: E501
+    success: StrictBool = Field(description="Always `true` on a success.")
+    data: PartnerNotificationSettingsChange
+    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 PartnerNotificationSettingsChangeResponse 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 PartnerNotificationSettingsChangeResponse 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": PartnerNotificationSettingsChange.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_notification_settings_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_notification_settings import PartnerNotificationSettings
+from api_sdk_py.models.response_meta import ResponseMeta
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PartnerNotificationSettingsResponse(BaseModel):
+    """
+    PartnerNotificationSettingsResponse
+    """ # noqa: E501
+    success: StrictBool = Field(description="Always `true` on a success.")
+    data: PartnerNotificationSettings
+    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 PartnerNotificationSettingsResponse 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 PartnerNotificationSettingsResponse 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": PartnerNotificationSettings.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_notification_test_event_request.py

@@ -0,0 +1,88 @@
+# 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
+from typing import Any, ClassVar, Dict, List
+from api_sdk_py.models.partner_notification_event_type import PartnerNotificationEventType
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PartnerNotificationTestEventRequest(BaseModel):
+    """
+    Which kind of event to send a sample of.
+    """ # noqa: E501
+    event_type: PartnerNotificationEventType = Field(alias="eventType")
+    __properties: ClassVar[List[str]] = ["eventType"]
+
+    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 PartnerNotificationTestEventRequest 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 PartnerNotificationTestEventRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "eventType": obj.get("eventType")
+        })
+        return _obj
+
+

api_sdk_py/models/partner_notification_test_event_result.py

@@ -0,0 +1,98 @@
+# 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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PartnerNotificationTestEventResult(BaseModel):
+    """
+    How a test call went. The call was made whether or not your receiver took it: read `delivered`.
+    """ # noqa: E501
+    delivered: StrictBool = Field(description="True when your receiver answered with a 2xx status.")
+    status_code: Optional[StrictInt] = Field(description="The HTTP status your receiver answered with. Null when it did not answer (refused, unreachable or too slow).", alias="statusCode")
+    duration_ms: StrictInt = Field(description="How long the call took, in milliseconds. A call is given up after ten seconds.", alias="durationMs")
+    error: Optional[StrictStr] = Field(default=None, description="Why the call did not arrive, in a few words (`timeout`, `status 500`, `unreachable`, a redirect). Never what your receiver replied. Left out when it arrived.")
+    __properties: ClassVar[List[str]] = ["delivered", "statusCode", "durationMs", "error"]
+
+    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 PartnerNotificationTestEventResult 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 status_code (nullable) is None
+        # and model_fields_set contains the field
+        if self.status_code is None and "status_code" in self.model_fields_set:
+            _dict['statusCode'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PartnerNotificationTestEventResult from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "delivered": obj.get("delivered"),
+            "statusCode": obj.get("statusCode"),
+            "durationMs": obj.get("durationMs"),
+            "error": obj.get("error")
+        })
+        return _obj
+
+