Regenerated from the update openapi spec with better human readable n…

…ames.

cyperf/models/action.py

@@ -30,18 +30,18 @@ class Action(BaseModel):
     Action
     """ # noqa: E501
     dst_host: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The destination host of the action.", alias="DstHost")
-    exchanges: List[Exchange] = Field(alias="Exchanges")
+    exchanges: Optional[List[Exchange]] = Field(default=None, alias="Exchanges")
     index: Optional[StrictInt] = Field(default=None, description="The index of the action.", alias="Index")
     is_banner: Optional[StrictBool] = Field(default=None, description="Indicates if this is a required action, can only be add once and also must be the first", alias="IsBanner")
     is_deprecated: Optional[StrictBool] = Field(default=None, description="A value that indicates if the action is deprecated.", alias="IsDeprecated")
     is_hostname: Optional[StrictInt] = Field(default=None, alias="IsHostname")
-    is_strike: StrictBool = Field(description="A value that indicates if the action is a strike.", alias="IsStrike")
+    is_strike: Optional[StrictBool] = Field(default=None, description="A value that indicates if the action is a strike.", alias="IsStrike")
     name: Optional[StrictStr] = Field(default=None, description="The name of the action.", alias="Name")
     params: Optional[List[Params]] = Field(default=None, alias="Params")
     port: Optional[StrictInt] = Field(default=None, description="The port of the destination host.", alias="Port")
-    protocol_id: StrictStr = Field(alias="ProtocolID")
+    protocol_id: Optional[StrictStr] = Field(default=None, alias="ProtocolID")
     requires_uniqueness: Optional[StrictBool] = Field(default=None, description="If true, for applications with the same protocol id, application/attack must have been uniquely identified in previous commands.", alias="RequiresUniqueness")
-    id: StrictStr
+    id: Optional[StrictStr] = None
     __properties: ClassVar[List[str]] = ["DstHost", "Exchanges", "Index", "IsBanner", "IsDeprecated", "IsHostname", "IsStrike", "Name", "Params", "Port", "ProtocolID", "RequiresUniqueness", "id"]
 
     @field_validator('dst_host')

cyperf/models/action_base.py

@@ -30,18 +30,18 @@ class ActionBase(BaseModel):
     ActionBase
     """ # noqa: E501
     dst_host: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The destination host of the action.", alias="DstHost")
-    exchanges: List[Exchange] = Field(alias="Exchanges")
+    exchanges: Optional[List[Exchange]] = Field(default=None, alias="Exchanges")
     index: Optional[StrictInt] = Field(default=None, description="The index of the action.", alias="Index")
     is_banner: Optional[StrictBool] = Field(default=None, description="Indicates if this is a required action, can only be add once and also must be the first", alias="IsBanner")
     is_deprecated: Optional[StrictBool] = Field(default=None, description="A value that indicates if the action is deprecated.", alias="IsDeprecated")
     is_hostname: Optional[StrictInt] = Field(default=None, alias="IsHostname")
-    is_strike: StrictBool = Field(description="A value that indicates if the action is a strike.", alias="IsStrike")
+    is_strike: Optional[StrictBool] = Field(default=None, description="A value that indicates if the action is a strike.", alias="IsStrike")
     name: Optional[StrictStr] = Field(default=None, description="The name of the action.", alias="Name")
     params: Optional[List[Params]] = Field(default=None, alias="Params")
     port: Optional[StrictInt] = Field(default=None, description="The port of the destination host.", alias="Port")
-    protocol_id: StrictStr = Field(alias="ProtocolID")
+    protocol_id: Optional[StrictStr] = Field(default=None, alias="ProtocolID")
     requires_uniqueness: Optional[StrictBool] = Field(default=None, description="If true, for applications with the same protocol id, application/attack must have been uniquely identified in previous commands.", alias="RequiresUniqueness")
-    id: StrictStr
+    id: Optional[StrictStr] = None
     __properties: ClassVar[List[str]] = ["DstHost", "Exchanges", "Index", "IsBanner", "IsDeprecated", "IsHostname", "IsStrike", "Name", "Params", "Port", "ProtocolID", "RequiresUniqueness", "id"]
 
     @field_validator('dst_host')

cyperf/models/agent_assignment_by_port.py

@@ -0,0 +1,95 @@
+# coding: utf-8
+
+"""
+    CyPerf Application API
+
+    CyPerf REST API
+
+    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 cyperf.models.capture_settings import CaptureSettings
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AgentAssignmentByPort(BaseModel):
+    """
+    Details of an agent assignment by port
+    """ # noqa: E501
+    capture_settings: Optional[CaptureSettings] = Field(default=None, description="The capture settings of the port that is assigned.", alias="captureSettings")
+    id: StrictStr
+    port_id: Optional[StrictStr] = Field(default=None, description="The id of the port that is assigned.", alias="portId")
+    __properties: ClassVar[List[str]] = ["captureSettings", "id", "portId"]
+
+    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 AgentAssignmentByPort 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 capture_settings
+        if self.capture_settings:
+            _dict['captureSettings'] = self.capture_settings.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AgentAssignmentByPort from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "captureSettings": CaptureSettings.from_dict(obj["captureSettings"]) if obj.get("captureSettings") is not None else None,
+            "id": obj.get("id"),
+            "portId": obj.get("portId")
+        })
+        return _obj
+
+

cyperf/models/agent_assignment_details.py

@@ -30,7 +30,7 @@ class AgentAssignmentDetails(BaseModel):
     agent_id: StrictStr = Field(description="The id of the agent that is assigned.", alias="agentId")
     capture_settings: Optional[CaptureSettings] = Field(default=None, description="The capture settings of the agent that is assigned.", alias="captureSettings")
     id: StrictStr
-    interfaces: List[StrictStr] = Field(description="The names of the assigned test interfaces for the agent.")
+    interfaces: Optional[List[StrictStr]] = Field(default=None, description="The names of the assigned test interfaces for the agent.")
     __properties: ClassVar[List[str]] = ["agentId", "captureSettings", "id", "interfaces"]
 
     model_config = ConfigDict(

cyperf/models/agent_assignments.py

@@ -18,7 +18,8 @@
 import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictStr
-from typing import Any, ClassVar, Dict, List
+from typing import Any, ClassVar, Dict, List, Optional
+from cyperf.models.agent_assignment_by_port import AgentAssignmentByPort
 from cyperf.models.agent_assignment_details import AgentAssignmentDetails
 from typing import Optional, Set
 from typing_extensions import Self
@@ -27,9 +28,10 @@ class AgentAssignments(BaseModel):
     """
     The agents assigned to the current test configuration
     """ # noqa: E501
-    by_id: List[AgentAssignmentDetails] = Field(description="The agents statically assigned to the current test configuration.", alias="ByID")
+    by_id: Optional[List[AgentAssignmentDetails]] = Field(default=None, description="The agents statically assigned to the current test configuration.", alias="ByID")
+    by_port: Optional[List[AgentAssignmentByPort]] = Field(default=None, description="The ports assigned to the current test configuration.", alias="ByPort")
     by_tag: List[StrictStr] = Field(description="The tags according to which the agents are dynamically assigned.", alias="ByTag")
-    __properties: ClassVar[List[str]] = ["ByID", "ByTag"]
+    __properties: ClassVar[List[str]] = ["ByID", "ByPort", "ByTag"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -77,6 +79,13 @@ def to_dict(self) -> Dict[str, Any]:
                 if _item_by_id:
                     _items.append(_item_by_id.to_dict())
             _dict['ByID'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in by_port (list)
+        _items = []
+        if self.by_port:
+            for _item_by_port in self.by_port:
+                if _item_by_port:
+                    _items.append(_item_by_port.to_dict())
+            _dict['ByPort'] = _items
         return _dict
 
     @classmethod
@@ -90,6 +99,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
 
         _obj = cls.model_validate({
             "ByID": [AgentAssignmentDetails.from_dict(_item) for _item in obj["ByID"]] if obj.get("ByID") is not None else None,
+            "ByPort": [AgentAssignmentByPort.from_dict(_item) for _item in obj["ByPort"]] if obj.get("ByPort") is not None else None,
             "ByTag": obj.get("ByTag")
         })
         return _obj

cyperf/models/api_link.py

@@ -28,9 +28,9 @@ class APILink(BaseModel):
     """ # noqa: E501
     content_type: Optional[StrictStr] = Field(default=None, alias="contentType")
     href: StrictStr
-    id: StrictStr
+    id: Optional[StrictStr] = None
     method: Optional[StrictStr] = None
-    name: StrictStr
+    name: Optional[StrictStr] = None
     references_count: Optional[StrictInt] = Field(default=None, alias="referencesCount")
     rel: StrictStr
     type: StrictStr

cyperf/models/app_exchange.py

@@ -0,0 +1,106 @@
+# coding: utf-8
+
+"""
+    CyPerf Application API
+
+    CyPerf REST API
+
+    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 cyperf.models.exchange_payload import ExchangePayload
+from cyperf.models.generic_file import GenericFile
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AppExchange(BaseModel):
+    """
+    AppExchange
+    """ # noqa: E501
+    c2s_payload: Optional[GenericFile] = Field(default=None, alias="c2sPayload")
+    id: Optional[StrictStr] = None
+    payload: Optional[ExchangePayload] = None
+    s2c_payload: Optional[GenericFile] = Field(default=None, alias="s2cPayload")
+    __properties: ClassVar[List[str]] = ["c2sPayload", "id", "payload", "s2cPayload"]
+
+    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 AppExchange 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([
+            "id",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of c2s_payload
+        if self.c2s_payload:
+            _dict['c2sPayload'] = self.c2s_payload.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of payload
+        if self.payload:
+            _dict['payload'] = self.payload.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of s2c_payload
+        if self.s2c_payload:
+            _dict['s2cPayload'] = self.s2c_payload.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AppExchange from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "c2sPayload": GenericFile.from_dict(obj["c2sPayload"]) if obj.get("c2sPayload") is not None else None,
+            "id": obj.get("id"),
+            "payload": ExchangePayload.from_dict(obj["payload"]) if obj.get("payload") is not None else None,
+            "s2cPayload": GenericFile.from_dict(obj["s2cPayload"]) if obj.get("s2cPayload") is not None else None
+        })
+        return _obj
+
+