mirror of
https://github.com/thousandeyes/thousandeyes-sdk-python.git
synced 2025-12-05 23:45:30 +00:00
e4068d6142
Some checks failed
Python CI / build (push) Has been cancelled
Co-authored-by: API Team <api-team@thousandeyes.com>
128 lines
6.0 KiB
Python
128 lines
6.0 KiB
Python
# coding: utf-8
|
||
|
||
"""
|
||
Administrative API
|
||
|
||
Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events. For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).
|
||
|
||
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, StrictStr
|
||
from typing import Any, ClassVar, Dict, List, Optional
|
||
from thousandeyes_sdk.administrative.models.coordinates import Coordinates
|
||
from typing import Optional, Set
|
||
from typing_extensions import Self
|
||
|
||
class SimpleAgent(BaseModel):
|
||
"""
|
||
SimpleAgent
|
||
""" # noqa: E501
|
||
ip_addresses: Optional[List[StrictStr]] = Field(default=None, description="Array of private IP addresses.", alias="ipAddresses")
|
||
public_ip_addresses: Optional[List[StrictStr]] = Field(default=None, description="Array of public IP addresses.", alias="publicIpAddresses")
|
||
network: Optional[StrictStr] = Field(default=None, description="Network (including ASN) of agent’s public IP.")
|
||
agent_id: Optional[StrictStr] = Field(default=None, description="Unique ID of the agent.", alias="agentId")
|
||
agent_name: Optional[StrictStr] = Field(default=None, description="Name of the agent.", alias="agentName")
|
||
location: Optional[StrictStr] = Field(default=None, description="Location of the agent.")
|
||
country_id: Optional[StrictStr] = Field(default=None, description="2-digit ISO country code", alias="countryId")
|
||
coordinates: Optional[Coordinates] = None
|
||
enabled: Optional[StrictBool] = Field(default=None, description="Flag indicating if the agent is enabled.")
|
||
prefix: Optional[StrictStr] = Field(default=None, description="Prefix containing agents public IP address.")
|
||
verify_ssl_certificates: Optional[StrictBool] = Field(default=None, description="Flag indicating if has normal SSL operations or if instead it's set to ignore SSL errors on browserbot-based tests.", alias="verifySslCertificates")
|
||
__properties: ClassVar[List[str]] = ["ipAddresses", "publicIpAddresses", "network", "agentId", "agentName", "location", "countryId", "coordinates", "enabled", "prefix", "verifySslCertificates"]
|
||
|
||
model_config = ConfigDict(
|
||
populate_by_name=True,
|
||
validate_assignment=True,
|
||
protected_namespaces=(),
|
||
extra="allow",
|
||
)
|
||
|
||
|
||
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 self.model_dump_json(by_alias=True, exclude_unset=True, exclude_none=True)
|
||
|
||
@classmethod
|
||
def from_json(cls, json_str: str) -> Optional[Self]:
|
||
"""Create an instance of SimpleAgent 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([
|
||
"ip_addresses",
|
||
"public_ip_addresses",
|
||
"network",
|
||
"agent_id",
|
||
"location",
|
||
"country_id",
|
||
"prefix",
|
||
"verify_ssl_certificates",
|
||
])
|
||
|
||
_dict = self.model_dump(
|
||
by_alias=True,
|
||
exclude=excluded_fields,
|
||
exclude_none=True,
|
||
)
|
||
# override the default output from pydantic by calling `to_dict()` of coordinates
|
||
if self.coordinates:
|
||
_dict['coordinates'] = self.coordinates.to_dict()
|
||
return _dict
|
||
|
||
@classmethod
|
||
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
|
||
"""Create an instance of SimpleAgent from a dict"""
|
||
if obj is None:
|
||
return None
|
||
|
||
if not isinstance(obj, dict):
|
||
return cls.model_validate(obj)
|
||
|
||
_obj = cls.model_validate({
|
||
"ipAddresses": obj.get("ipAddresses"),
|
||
"publicIpAddresses": obj.get("publicIpAddresses"),
|
||
"network": obj.get("network"),
|
||
"agentId": obj.get("agentId"),
|
||
"agentName": obj.get("agentName"),
|
||
"location": obj.get("location"),
|
||
"countryId": obj.get("countryId"),
|
||
"coordinates": Coordinates.from_dict(obj["coordinates"]) if obj.get("coordinates") is not None else None,
|
||
"enabled": obj.get("enabled"),
|
||
"prefix": obj.get("prefix"),
|
||
"verifySslCertificates": obj.get("verifySslCertificates")
|
||
})
|
||
return _obj
|
||
|
||
|