thousandeyes-sdk-instant-tests 1.0.0__py3-none-any.whl

thousandeyes_sdk/instant_tests/models/test_auth_type.py

@@ -0,0 +1,40 @@
+# coding: utf-8
+
+"""
+    Instant Tests API
+
+    The Instant Tests API endpoint lets you create and run new instant tests. You will need to be a regular user or have the following permissions:   * `API Access`   * `View tests`  The response does not include the immediate test results. Use the Test Results endpoints to get test results after creating and executing an instant test. You can find the URLs for these endpoints in the _links section of the test definition that is returned when you create the instant test. 
+
+    The version of the OpenAPI document: 7.0.8
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class TestAuthType(str, Enum):
+    """
+    HTTP authentication type.
+    """
+
+    """
+    allowed enum values
+    """
+    NONE = 'none'
+    BASIC = 'basic'
+    NTLM = 'ntlm'
+    KERBEROS = 'kerberos'
+    OAUTH = 'oauth'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of TestAuthType from a JSON string"""
+        return cls(json.loads(json_str))
+
+

thousandeyes_sdk/instant_tests/models/test_custom_headers.py

@@ -0,0 +1,92 @@
+# coding: utf-8
+
+"""
+    Instant Tests API
+
+    The Instant Tests API endpoint lets you create and run new instant tests. You will need to be a regular user or have the following permissions:   * `API Access`   * `View tests`  The response does not include the immediate test results. Use the Test Results endpoints to get test results after creating and executing an instant test. You can find the URLs for these endpoints in the _links section of the test definition that is returned when you create the instant test. 
+
+    The version of the OpenAPI document: 7.0.8
+    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 typing import Optional, Set
+from typing_extensions import Self
+
+class TestCustomHeaders(BaseModel):
+    """
+    TestCustomHeaders
+    """ # noqa: E501
+    root: Optional[Dict[str, StrictStr]] = Field(default=None, description="Use these HTTP headers for root server request.")
+    domains: Optional[Dict[str, Dict[str, StrictStr]]] = Field(default=None, description="Use these HTTP headers for the specified domains.")
+    all: Optional[Dict[str, StrictStr]] = Field(default=None, description="Use these HTTP headers for all domains.")
+    __properties: ClassVar[List[str]] = ["root", "domains", "all"]
+
+    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 TestCustomHeaders 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 TestCustomHeaders from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "root": obj.get("root"),
+            "domains": obj.get("domains"),
+            "all": obj.get("all")
+        })
+        return _obj
+
+

thousandeyes_sdk/instant_tests/models/test_direction.py

@@ -0,0 +1,38 @@
+# coding: utf-8
+
+"""
+    Instant Tests API
+
+    The Instant Tests API endpoint lets you create and run new instant tests. You will need to be a regular user or have the following permissions:   * `API Access`   * `View tests`  The response does not include the immediate test results. Use the Test Results endpoints to get test results after creating and executing an instant test. You can find the URLs for these endpoints in the _links section of the test definition that is returned when you create the instant test. 
+
+    The version of the OpenAPI document: 7.0.8
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class TestDirection(str, Enum):
+    """
+    Direction of the test, which affects how results are shown.
+    """
+
+    """
+    allowed enum values
+    """
+    TO_MINUS_TARGET = 'to-target'
+    FROM_MINUS_TARGET = 'from-target'
+    BIDIRECTIONAL = 'bidirectional'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of TestDirection from a JSON string"""
+        return cls(json.loads(json_str))
+
+

thousandeyes_sdk/instant_tests/models/test_dns_server.py

@@ -0,0 +1,90 @@
+# coding: utf-8
+
+"""
+    Instant Tests API
+
+    The Instant Tests API endpoint lets you create and run new instant tests. You will need to be a regular user or have the following permissions:   * `API Access`   * `View tests`  The response does not include the immediate test results. Use the Test Results endpoints to get test results after creating and executing an instant test. You can find the URLs for these endpoints in the _links section of the test definition that is returned when you create the instant test. 
+
+    The version of the OpenAPI document: 7.0.8
+    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 typing import Optional, Set
+from typing_extensions import Self
+
+class TestDnsServer(BaseModel):
+    """
+    TestDnsServer
+    """ # noqa: E501
+    server_id: Optional[StrictStr] = Field(default=None, description="Unique identifier of the DNS server.", alias="serverId")
+    server_name: Optional[StrictStr] = Field(default=None, description="Fully qualified domain name (FQDN) of DNS server.", alias="serverName")
+    __properties: ClassVar[List[str]] = ["serverId", "serverName"]
+
+    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 TestDnsServer 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 TestDnsServer from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "serverId": obj.get("serverId"),
+            "serverName": obj.get("serverName")
+        })
+        return _obj
+
+

thousandeyes_sdk/instant_tests/models/test_dns_transport_protocol.py

@@ -0,0 +1,37 @@
+# coding: utf-8
+
+"""
+    Instant Tests API
+
+    The Instant Tests API endpoint lets you create and run new instant tests. You will need to be a regular user or have the following permissions:   * `API Access`   * `View tests`  The response does not include the immediate test results. Use the Test Results endpoints to get test results after creating and executing an instant test. You can find the URLs for these endpoints in the _links section of the test definition that is returned when you create the instant test. 
+
+    The version of the OpenAPI document: 7.0.8
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class TestDnsTransportProtocol(str, Enum):
+    """
+    Transport protocol used for DNS requests.
+    """
+
+    """
+    allowed enum values
+    """
+    UDP = 'udp'
+    TCP = 'tcp'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of TestDnsTransportProtocol from a JSON string"""
+        return cls(json.loads(json_str))
+
+

thousandeyes_sdk/instant_tests/models/test_dscp_id.py

@@ -0,0 +1,57 @@
+# coding: utf-8
+
+"""
+    Instant Tests API
+
+    The Instant Tests API endpoint lets you create and run new instant tests. You will need to be a regular user or have the following permissions:   * `API Access`   * `View tests`  The response does not include the immediate test results. Use the Test Results endpoints to get test results after creating and executing an instant test. You can find the URLs for these endpoints in the _links section of the test definition that is returned when you create the instant test. 
+
+    The version of the OpenAPI document: 7.0.8
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class TestDscpId(str, Enum):
+    """
+    DSCP ID [to see list for acceptable values](https://docs.thousandeyes.com/product-documentation/tests/dscp-options-in-network-tests)
+    """
+
+    """
+    allowed enum values
+    """
+    ENUM_0 = '0'
+    ENUM_8 = '8'
+    ENUM_16 = '16'
+    ENUM_24 = '24'
+    ENUM_32 = '32'
+    ENUM_40 = '40'
+    ENUM_48 = '48'
+    ENUM_56 = '56'
+    ENUM_10 = '10'
+    ENUM_12 = '12'
+    ENUM_14 = '14'
+    ENUM_18 = '18'
+    ENUM_20 = '20'
+    ENUM_22 = '22'
+    ENUM_26 = '26'
+    ENUM_28 = '28'
+    ENUM_30 = '30'
+    ENUM_34 = '34'
+    ENUM_36 = '36'
+    ENUM_38 = '38'
+    ENUM_46 = '46'
+    ENUM_44 = '44'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of TestDscpId from a JSON string"""
+        return cls(json.loads(json_str))
+
+

thousandeyes_sdk/instant_tests/models/test_ipv6_policy.py

@@ -0,0 +1,39 @@
+# coding: utf-8
+
+"""
+    Instant Tests API
+
+    The Instant Tests API endpoint lets you create and run new instant tests. You will need to be a regular user or have the following permissions:   * `API Access`   * `View tests`  The response does not include the immediate test results. Use the Test Results endpoints to get test results after creating and executing an instant test. You can find the URLs for these endpoints in the _links section of the test definition that is returned when you create the instant test. 
+
+    The version of the OpenAPI document: 7.0.8
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class TestIpv6Policy(str, Enum):
+    """
+    IP version policy. Overrides the IPv6 policy configured at the agent level.
+    """
+
+    """
+    allowed enum values
+    """
+    FORCE_MINUS_IPV4 = 'force-ipv4'
+    PREFER_MINUS_IPV6 = 'prefer-ipv6'
+    FORCE_MINUS_IPV6 = 'force-ipv6'
+    USE_MINUS_AGENT_MINUS_POLICY = 'use-agent-policy'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of TestIpv6Policy from a JSON string"""
+        return cls(json.loads(json_str))
+
+

thousandeyes_sdk/instant_tests/models/test_label.py

@@ -0,0 +1,92 @@
+# coding: utf-8
+
+"""
+    Instant Tests API
+
+    The Instant Tests API endpoint lets you create and run new instant tests. You will need to be a regular user or have the following permissions:   * `API Access`   * `View tests`  The response does not include the immediate test results. Use the Test Results endpoints to get test results after creating and executing an instant test. You can find the URLs for these endpoints in the _links section of the test definition that is returned when you create the instant test. 
+
+    The version of the OpenAPI document: 7.0.8
+    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 typing import Optional, Set
+from typing_extensions import Self
+
+class TestLabel(BaseModel):
+    """
+    TestLabel
+    """ # noqa: E501
+    label_id: Optional[StrictStr] = Field(default=None, description="Label ID.", alias="labelId")
+    name: Optional[StrictStr] = Field(default=None, description="Name of the label.")
+    is_builtin: Optional[StrictBool] = Field(default=None, description="Value indicating if the label in question is BuiltIn (Account Admin, Organization Admin, Regular User).", alias="isBuiltin")
+    __properties: ClassVar[List[str]] = ["labelId", "name", "isBuiltin"]
+
+    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 TestLabel 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 TestLabel from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "labelId": obj.get("labelId"),
+            "name": obj.get("name"),
+            "isBuiltin": obj.get("isBuiltin")
+        })
+        return _obj
+
+

thousandeyes_sdk/instant_tests/models/test_links.py

@@ -0,0 +1,102 @@
+# coding: utf-8
+
+"""
+    Instant Tests API
+
+    The Instant Tests API endpoint lets you create and run new instant tests. You will need to be a regular user or have the following permissions:   * `API Access`   * `View tests`  The response does not include the immediate test results. Use the Test Results endpoints to get test results after creating and executing an instant test. You can find the URLs for these endpoints in the _links section of the test definition that is returned when you create the instant test. 
+
+    The version of the OpenAPI document: 7.0.8
+    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, Optional
+from thousandeyes_sdk.instant_tests.models.link import Link
+from thousandeyes_sdk.instant_tests.models.test_self_link import TestSelfLink
+from typing import Optional, Set
+from typing_extensions import Self
+
+class TestLinks(BaseModel):
+    """
+    A list of links that can be accessed to get more information
+    """ # noqa: E501
+    var_self: Optional[TestSelfLink] = Field(default=None, alias="self")
+    test_results: Optional[List[Link]] = Field(default=None, description="Reference to the test results.", alias="testResults")
+    __properties: ClassVar[List[str]] = ["self", "testResults"]
+
+    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 TestLinks 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 var_self
+        if self.var_self:
+            _dict['self'] = self.var_self.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in test_results (list)
+        _items = []
+        if self.test_results:
+            for _item in self.test_results:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['testResults'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of TestLinks from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "self": TestSelfLink.from_dict(obj["self"]) if obj.get("self") is not None else None,
+            "testResults": [Link.from_dict(_item) for _item in obj["testResults"]] if obj.get("testResults") is not None else None
+        })
+        return _obj
+
+

thousandeyes_sdk/instant_tests/models/test_page_loading_strategy.py

@@ -0,0 +1,38 @@
+# coding: utf-8
+
+"""
+    Instant Tests API
+
+    The Instant Tests API endpoint lets you create and run new instant tests. You will need to be a regular user or have the following permissions:   * `API Access`   * `View tests`  The response does not include the immediate test results. Use the Test Results endpoints to get test results after creating and executing an instant test. You can find the URLs for these endpoints in the _links section of the test definition that is returned when you create the instant test. 
+
+    The version of the OpenAPI document: 7.0.8
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class TestPageLoadingStrategy(str, Enum):
+    """
+    * `normal`: The test waits until the entire page is fully loaded, including the downloading and parsing of HTML content as well as all associated resources, before advancing to the next action in the transaction test script.  * `eager`: The test waits for the DOMContentLoaded event, indicating that HTML content is downloaded and parsed, and the document reaches the \"interactive\" readiness state, before proceeding to the next action in the test script. * `none`: The test only waits for the download of HTML content. Once the HTML is downloaded, the test continues to the next action in the transaction test script without waiting for additional resources. 
+    """
+
+    """
+    allowed enum values
+    """
+    NORMAL = 'normal'
+    EAGER = 'eager'
+    NONE = 'none'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of TestPageLoadingStrategy from a JSON string"""
+        return cls(json.loads(json_str))
+
+

thousandeyes_sdk/instant_tests/models/test_path_trace_mode.py

@@ -0,0 +1,37 @@
+# coding: utf-8
+
+"""
+    Instant Tests API
+
+    The Instant Tests API endpoint lets you create and run new instant tests. You will need to be a regular user or have the following permissions:   * `API Access`   * `View tests`  The response does not include the immediate test results. Use the Test Results endpoints to get test results after creating and executing an instant test. You can find the URLs for these endpoints in the _links section of the test definition that is returned when you create the instant test. 
+
+    The version of the OpenAPI document: 7.0.8
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class TestPathTraceMode(str, Enum):
+    """
+    Select `inSession` to perform the path trace within a TCP session.
+    """
+
+    """
+    allowed enum values
+    """
+    CLASSIC = 'classic'
+    IN_MINUS_SESSION = 'in-session'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of TestPathTraceMode from a JSON string"""
+        return cls(json.loads(json_str))
+
+