mirror of
https://github.com/thousandeyes/thousandeyes-sdk-python.git
synced 2025-12-06 07:55:31 +00:00
126 lines
6.5 KiB
Python
126 lines
6.5 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.enterprise_agent import EnterpriseAgent
|
|
from thousandeyes_sdk.administrative.models.self_links import SelfLinks
|
|
from thousandeyes_sdk.administrative.models.user_account_group import UserAccountGroup
|
|
from typing import Optional, Set
|
|
from typing_extensions import Self
|
|
|
|
class AccountGroupDetail(BaseModel):
|
|
"""
|
|
AccountGroupDetail
|
|
""" # noqa: E501
|
|
aid: Optional[StrictStr] = Field(default=None, description="A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint.")
|
|
account_group_name: Optional[StrictStr] = Field(default=None, description="Account group name", alias="accountGroupName")
|
|
is_current_account_group: Optional[StrictBool] = Field(default=None, description="Indicates whether the requested aid is the context of the current account.", alias="isCurrentAccountGroup")
|
|
is_default_account_group: Optional[StrictBool] = Field(default=None, description="Indicates whether the aid is the default one for the requesting user.", alias="isDefaultAccountGroup")
|
|
organization_name: Optional[StrictStr] = Field(default=None, description="(Optional) The name of the organization associated with the account group.", alias="organizationName")
|
|
org_id: Optional[StrictStr] = Field(default=None, description="(Optional) The ID for the organization associated with the account group.", alias="orgId")
|
|
users: Optional[List[UserAccountGroup]] = None
|
|
links: Optional[SelfLinks] = Field(default=None, alias="_links")
|
|
agents: Optional[List[EnterpriseAgent]] = None
|
|
account_token: Optional[StrictStr] = Field(default=None, description="The account group token is an alphanumeric string used to bind an Enterprise Agent to a specific account group. This token is not a password that must be kept secret. You can retrieve your `AccountGroupToken` from the `/account-groups/{id}` endpoint.", alias="accountToken")
|
|
__properties: ClassVar[List[str]] = ["aid", "accountGroupName", "isCurrentAccountGroup", "isDefaultAccountGroup", "organizationName", "orgId", "users", "_links", "agents", "accountToken"]
|
|
|
|
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 AccountGroupDetail 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 users (list)
|
|
_items = []
|
|
if self.users:
|
|
for _item in self.users:
|
|
if _item:
|
|
_items.append(_item.to_dict())
|
|
_dict['users'] = _items
|
|
# override the default output from pydantic by calling `to_dict()` of links
|
|
if self.links:
|
|
_dict['_links'] = self.links.to_dict()
|
|
# override the default output from pydantic by calling `to_dict()` of each item in agents (list)
|
|
_items = []
|
|
if self.agents:
|
|
for _item in self.agents:
|
|
if _item:
|
|
_items.append(_item.to_dict())
|
|
_dict['agents'] = _items
|
|
return _dict
|
|
|
|
@classmethod
|
|
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
|
|
"""Create an instance of AccountGroupDetail from a dict"""
|
|
if obj is None:
|
|
return None
|
|
|
|
if not isinstance(obj, dict):
|
|
return cls.model_validate(obj)
|
|
|
|
_obj = cls.model_validate({
|
|
"aid": obj.get("aid"),
|
|
"accountGroupName": obj.get("accountGroupName"),
|
|
"isCurrentAccountGroup": obj.get("isCurrentAccountGroup"),
|
|
"isDefaultAccountGroup": obj.get("isDefaultAccountGroup"),
|
|
"organizationName": obj.get("organizationName"),
|
|
"orgId": obj.get("orgId"),
|
|
"users": [UserAccountGroup.from_dict(_item) for _item in obj["users"]] if obj.get("users") is not None else None,
|
|
"_links": SelfLinks.from_dict(obj["_links"]) if obj.get("_links") is not None else None,
|
|
"agents": [EnterpriseAgent.from_dict(_item) for _item in obj["agents"]] if obj.get("agents") is not None else None,
|
|
"accountToken": obj.get("accountToken")
|
|
})
|
|
return _obj
|
|
|
|
|