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

thousandeyes_sdk/instant_tests/models/voice_properties.py

@@ -0,0 +1,114 @@
+# 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_extensions import Annotated
+from thousandeyes_sdk.instant_tests.models.test_dscp_id import TestDscpId
+from typing import Optional, Set
+from typing_extensions import Self
+
+class VoiceProperties(BaseModel):
+    """
+    VoiceProperties
+    """ # noqa: E501
+    codec: Optional[StrictStr] = Field(default=None, description="Codec label")
+    codec_id: Optional[StrictStr] = Field(default=None, description="Coded ID, [see the list of acceptable values](https://docs.thousandeyes.com/product-documentation/internet-and-wan-monitoring/tests/working-with-test-settings#rtp-stream-advanced-settings-tab)", alias="codecId")
+    dscp: Optional[StrictStr] = Field(default=None, description="DSCP label.")
+    dscp_id: Optional[TestDscpId] = Field(default=None, alias="dscpId")
+    duration: Optional[Annotated[int, Field(le=30, strict=True, ge=5)]] = Field(default=5, description="Duration of the test in seconds.")
+    jitter_buffer: Optional[Annotated[int, Field(le=150, strict=True, ge=0)]] = Field(default=40, description="De-jitter buffer size in seconds.", alias="jitterBuffer")
+    num_path_traces: Optional[Annotated[int, Field(le=10, strict=True, ge=1)]] = Field(default=3, description="Number of path traces executed by the agent.", alias="numPathTraces")
+    port: Optional[Annotated[int, Field(le=65535, strict=True, ge=1024)]] = Field(default=None, description="Port number for the chosen protocol.")
+    target_agent_id: StrictStr = Field(description="Agent ID of the target agent for the test.", alias="targetAgentId")
+    type: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["codec", "codecId", "dscp", "dscpId", "duration", "jitterBuffer", "numPathTraces", "port", "targetAgentId", "type"]
+
+    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 VoiceProperties 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.
+        """
+        excluded_fields: Set[str] = set([
+            "codec",
+            "dscp",
+            "type",
+        ])
+
+        _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 VoiceProperties from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "codec": obj.get("codec"),
+            "codecId": obj.get("codecId"),
+            "dscp": obj.get("dscp"),
+            "dscpId": obj.get("dscpId"),
+            "duration": obj.get("duration") if obj.get("duration") is not None else 5,
+            "jitterBuffer": obj.get("jitterBuffer") if obj.get("jitterBuffer") is not None else 40,
+            "numPathTraces": obj.get("numPathTraces") if obj.get("numPathTraces") is not None else 3,
+            "port": obj.get("port"),
+            "targetAgentId": obj.get("targetAgentId"),
+            "type": obj.get("type")
+        })
+        return _obj
+
+

thousandeyes_sdk/instant_tests/models/web_transaction_instant_test.py

@@ -0,0 +1,258 @@
+# 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 datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from thousandeyes_sdk.instant_tests.models.agent import Agent
+from thousandeyes_sdk.instant_tests.models.shared_with_account import SharedWithAccount
+from thousandeyes_sdk.instant_tests.models.test_auth_type import TestAuthType
+from thousandeyes_sdk.instant_tests.models.test_custom_headers import TestCustomHeaders
+from thousandeyes_sdk.instant_tests.models.test_label import TestLabel
+from thousandeyes_sdk.instant_tests.models.test_links import TestLinks
+from thousandeyes_sdk.instant_tests.models.test_page_loading_strategy import TestPageLoadingStrategy
+from thousandeyes_sdk.instant_tests.models.test_path_trace_mode import TestPathTraceMode
+from thousandeyes_sdk.instant_tests.models.test_probe_mode import TestProbeMode
+from thousandeyes_sdk.instant_tests.models.test_protocol import TestProtocol
+from thousandeyes_sdk.instant_tests.models.test_ssl_version_id import TestSslVersionId
+from typing import Optional, Set
+from typing_extensions import Self
+
+class WebTransactionInstantTest(BaseModel):
+    """
+    WebTransactionInstantTest
+    """ # noqa: E501
+    created_by: Optional[StrictStr] = Field(default=None, description="User that created the test.", alias="createdBy")
+    created_date: Optional[datetime] = Field(default=None, description="UTC created date (ISO date-time format).", alias="createdDate")
+    description: Optional[StrictStr] = Field(default=None, description="A description of the test.")
+    live_share: Optional[StrictBool] = Field(default=None, description="Indicates if the test is shared with the account group.", alias="liveShare")
+    modified_by: Optional[StrictStr] = Field(default=None, description="User that modified the test.", alias="modifiedBy")
+    modified_date: Optional[datetime] = Field(default=None, description="UTC last modification date (ISO date-time format).", alias="modifiedDate")
+    saved_event: Optional[StrictBool] = Field(default=None, description="Indicates if the test is a saved event.", alias="savedEvent")
+    test_id: Optional[StrictStr] = Field(default=None, description="Each test is assigned an unique ID; this is used to access test information and results from other endpoints.", alias="testId")
+    test_name: Optional[StrictStr] = Field(default=None, description="The name of the test. Test name must be unique.", alias="testName")
+    type: Optional[StrictStr] = None
+    links: Optional[TestLinks] = Field(default=None, alias="_links")
+    labels: Optional[List[TestLabel]] = None
+    shared_with_accounts: Optional[List[SharedWithAccount]] = Field(default=None, alias="sharedWithAccounts")
+    auth_type: Optional[TestAuthType] = Field(default=None, alias="authType")
+    bandwidth_measurements: Optional[StrictBool] = Field(default=None, description="Set to `true` to enable bandwidth measurements, only applies to Enterprise agents assigned to the test.", alias="bandwidthMeasurements")
+    client_certificate: Optional[StrictStr] = Field(default=None, description="String representation (containing newline characters) of client certificate, the private key must be placed first, then the certificate.", alias="clientCertificate")
+    content_regex: Optional[StrictStr] = Field(default=None, description="Verify content using a regular expression. This field does not require escaping.", alias="contentRegex")
+    custom_headers: Optional[TestCustomHeaders] = Field(default=None, alias="customHeaders")
+    desired_status_code: Optional[StrictStr] = Field(default='200', description="Specify the HTTP status code value that indicates a successful response.", alias="desiredStatusCode")
+    emulated_device_id: Optional[StrictStr] = Field(default=None, description="id of the emulated device, if one was given when the test was created", alias="emulatedDeviceId")
+    follow_redirects: Optional[StrictBool] = Field(default=True, description="To disable following HTTP/301 or HTTP/302 redirect directives, set this parameter to `false`.", alias="followRedirects")
+    http_target_time: Optional[Annotated[int, Field(le=5000, strict=True, ge=100)]] = Field(default=None, description="Target time for HTTP server completion, specified in milliseconds.", alias="httpTargetTime")
+    http_time_limit: Optional[Annotated[int, Field(le=60, strict=True, ge=5)]] = Field(default=5, description="HTTP time limit in seconds.", alias="httpTimeLimit")
+    http_version: Optional[Annotated[int, Field(le=2, strict=True, ge=1)]] = Field(default=2, description="HTTP protocol version. Set to '2' to prefer HTTP/2, or '1' to use only HTTP/1.1.", alias="httpVersion")
+    include_headers: Optional[StrictBool] = Field(default=True, description="Set to `true` to capture response headers for objects loaded by the test.", alias="includeHeaders")
+    mtu_measurements: Optional[StrictBool] = Field(default=None, description="Set `true` to measure MTU sizes on network from agents to the target.", alias="mtuMeasurements")
+    network_measurements: Optional[StrictBool] = Field(default=True, description="Enable or disable network measurements. Set to true to enable or false to disable network measurements.", alias="networkMeasurements")
+    num_path_traces: Optional[Annotated[int, Field(le=10, strict=True, ge=1)]] = Field(default=3, description="Number of path traces executed by the agent.", alias="numPathTraces")
+    password: Optional[StrictStr] = Field(default=None, description="Password for Basic/NTLM authentication.")
+    path_trace_mode: Optional[TestPathTraceMode] = Field(default=None, alias="pathTraceMode")
+    probe_mode: Optional[TestProbeMode] = Field(default=None, alias="probeMode")
+    protocol: Optional[TestProtocol] = None
+    ssl_version: Optional[StrictStr] = Field(default=None, description="Reflects the verbose SSL protocol version used by a test.", alias="sslVersion")
+    ssl_version_id: Optional[TestSslVersionId] = Field(default=None, alias="sslVersionId")
+    target_time: Optional[Annotated[int, Field(le=60, strict=True, ge=0)]] = Field(default=None, description="Target time for completion, defaults to 50% of time limit specified in seconds. (0 means default behavior)", alias="targetTime")
+    time_limit: Optional[Annotated[int, Field(le=180, strict=True, ge=5)]] = Field(default=30, description="Time limit for transaction in seconds.", alias="timeLimit")
+    transaction_script: StrictStr = Field(description="JavaScript of a web transaction test. Quotes must be escaped (precede \" characters with \\ ).", alias="transactionScript")
+    url: StrictStr = Field(description="Target for the test.")
+    use_ntlm: Optional[StrictBool] = Field(default=None, description="Set to true to use NTLM, false to use Basic Authentication. Requires username and password to be set.", alias="useNtlm")
+    user_agent: Optional[StrictStr] = Field(default=None, description="User-agent string to be provided during the test.", alias="userAgent")
+    username: Optional[StrictStr] = Field(default=None, description="Username for Basic/NTLM authentication.")
+    verify_certificate: Optional[StrictBool] = Field(default=False, description="Ignore or acknowledge certificate errors. Set to false to ignore certificate errors.", alias="verifyCertificate")
+    allow_unsafe_legacy_renegotiation: Optional[StrictBool] = Field(default=True, description="Allows TLS renegotiation with servers not supporting RFC 5746. Default Set to true to allow unsafe legacy renegotiation.", alias="allowUnsafeLegacyRenegotiation")
+    block_domains: Optional[StrictStr] = Field(default=None, description="Domains or full object URLs to be excluded from metrics and waterfall data for transaction tests.", alias="blockDomains")
+    disable_screenshot: Optional[StrictBool] = Field(default=False, description="Enables or disables screenshots on error. Set true to not capture", alias="disableScreenshot")
+    allow_mic_and_camera: Optional[StrictBool] = Field(default=False, description="Set true allow the use of a fake mic and camera in the browser.", alias="allowMicAndCamera")
+    allow_geolocation: Optional[StrictBool] = Field(default=False, description="Set true to use the agent’s geolocation by the web page.", alias="allowGeolocation")
+    browser_language: Optional[StrictStr] = Field(default=None, description="Set one of the available browser language that you want to use to configure the browser.", alias="browserLanguage")
+    page_loading_strategy: Optional[TestPageLoadingStrategy] = Field(default=None, alias="pageLoadingStrategy")
+    fixed_packet_rate: Optional[Annotated[int, Field(le=100, strict=True, ge=0)]] = Field(default=None, description="Sets packets rate sent to measure the network in packets per second.", alias="fixedPacketRate")
+    override_agent_proxy: Optional[StrictBool] = Field(default=False, description="Flag indicating if a proxy other than the default should be used. To override the default proxy for agents, set to `true` and specify a value for `overrideProxyId`.", alias="overrideAgentProxy")
+    override_proxy_id: Optional[StrictStr] = Field(default=None, description="ID of the proxy to be used if the default proxy is overridden.", alias="overrideProxyId")
+    agents: Optional[List[Agent]] = Field(default=None, description="Contains list of agents.")
+    credentials: Optional[List[StrictStr]] = Field(default=None, description="Contains a list of credential IDs (get `credentialId` from `/credentials` endpoint).")
+    __properties: ClassVar[List[str]] = ["createdBy", "createdDate", "description", "liveShare", "modifiedBy", "modifiedDate", "savedEvent", "testId", "testName", "type", "_links", "labels", "sharedWithAccounts", "authType", "bandwidthMeasurements", "clientCertificate", "contentRegex", "customHeaders", "desiredStatusCode", "emulatedDeviceId", "followRedirects", "httpTargetTime", "httpTimeLimit", "httpVersion", "includeHeaders", "mtuMeasurements", "networkMeasurements", "numPathTraces", "password", "pathTraceMode", "probeMode", "protocol", "sslVersion", "sslVersionId", "targetTime", "timeLimit", "transactionScript", "url", "useNtlm", "userAgent", "username", "verifyCertificate", "allowUnsafeLegacyRenegotiation", "blockDomains", "disableScreenshot", "allowMicAndCamera", "allowGeolocation", "browserLanguage", "pageLoadingStrategy", "fixedPacketRate", "overrideAgentProxy", "overrideProxyId", "agents", "credentials"]
+
+    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 WebTransactionInstantTest 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.
+        * 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([
+            "created_by",
+            "created_date",
+            "live_share",
+            "modified_by",
+            "modified_date",
+            "saved_event",
+            "test_id",
+            "type",
+            "labels",
+            "shared_with_accounts",
+            "ssl_version",
+            "agents",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # 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 labels (list)
+        _items = []
+        if self.labels:
+            for _item in self.labels:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['labels'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in shared_with_accounts (list)
+        _items = []
+        if self.shared_with_accounts:
+            for _item in self.shared_with_accounts:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['sharedWithAccounts'] = _items
+        # override the default output from pydantic by calling `to_dict()` of custom_headers
+        if self.custom_headers:
+            _dict['customHeaders'] = self.custom_headers.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 WebTransactionInstantTest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "createdBy": obj.get("createdBy"),
+            "createdDate": obj.get("createdDate"),
+            "description": obj.get("description"),
+            "liveShare": obj.get("liveShare"),
+            "modifiedBy": obj.get("modifiedBy"),
+            "modifiedDate": obj.get("modifiedDate"),
+            "savedEvent": obj.get("savedEvent"),
+            "testId": obj.get("testId"),
+            "testName": obj.get("testName"),
+            "type": obj.get("type"),
+            "_links": TestLinks.from_dict(obj["_links"]) if obj.get("_links") is not None else None,
+            "labels": [TestLabel.from_dict(_item) for _item in obj["labels"]] if obj.get("labels") is not None else None,
+            "sharedWithAccounts": [SharedWithAccount.from_dict(_item) for _item in obj["sharedWithAccounts"]] if obj.get("sharedWithAccounts") is not None else None,
+            "authType": obj.get("authType"),
+            "bandwidthMeasurements": obj.get("bandwidthMeasurements"),
+            "clientCertificate": obj.get("clientCertificate"),
+            "contentRegex": obj.get("contentRegex"),
+            "customHeaders": TestCustomHeaders.from_dict(obj["customHeaders"]) if obj.get("customHeaders") is not None else None,
+            "desiredStatusCode": obj.get("desiredStatusCode") if obj.get("desiredStatusCode") is not None else '200',
+            "emulatedDeviceId": obj.get("emulatedDeviceId"),
+            "followRedirects": obj.get("followRedirects") if obj.get("followRedirects") is not None else True,
+            "httpTargetTime": obj.get("httpTargetTime"),
+            "httpTimeLimit": obj.get("httpTimeLimit") if obj.get("httpTimeLimit") is not None else 5,
+            "httpVersion": obj.get("httpVersion") if obj.get("httpVersion") is not None else 2,
+            "includeHeaders": obj.get("includeHeaders") if obj.get("includeHeaders") is not None else True,
+            "mtuMeasurements": obj.get("mtuMeasurements"),
+            "networkMeasurements": obj.get("networkMeasurements") if obj.get("networkMeasurements") is not None else True,
+            "numPathTraces": obj.get("numPathTraces") if obj.get("numPathTraces") is not None else 3,
+            "password": obj.get("password"),
+            "pathTraceMode": obj.get("pathTraceMode"),
+            "probeMode": obj.get("probeMode"),
+            "protocol": obj.get("protocol"),
+            "sslVersion": obj.get("sslVersion"),
+            "sslVersionId": obj.get("sslVersionId"),
+            "targetTime": obj.get("targetTime"),
+            "timeLimit": obj.get("timeLimit") if obj.get("timeLimit") is not None else 30,
+            "transactionScript": obj.get("transactionScript"),
+            "url": obj.get("url"),
+            "useNtlm": obj.get("useNtlm"),
+            "userAgent": obj.get("userAgent"),
+            "username": obj.get("username"),
+            "verifyCertificate": obj.get("verifyCertificate") if obj.get("verifyCertificate") is not None else False,
+            "allowUnsafeLegacyRenegotiation": obj.get("allowUnsafeLegacyRenegotiation") if obj.get("allowUnsafeLegacyRenegotiation") is not None else True,
+            "blockDomains": obj.get("blockDomains"),
+            "disableScreenshot": obj.get("disableScreenshot") if obj.get("disableScreenshot") is not None else False,
+            "allowMicAndCamera": obj.get("allowMicAndCamera") if obj.get("allowMicAndCamera") is not None else False,
+            "allowGeolocation": obj.get("allowGeolocation") if obj.get("allowGeolocation") is not None else False,
+            "browserLanguage": obj.get("browserLanguage"),
+            "pageLoadingStrategy": obj.get("pageLoadingStrategy"),
+            "fixedPacketRate": obj.get("fixedPacketRate"),
+            "overrideAgentProxy": obj.get("overrideAgentProxy") if obj.get("overrideAgentProxy") is not None else False,
+            "overrideProxyId": obj.get("overrideProxyId"),
+            "agents": [Agent.from_dict(_item) for _item in obj["agents"]] if obj.get("agents") is not None else None,
+            "credentials": obj.get("credentials")
+        })
+        return _obj
+
+

thousandeyes_sdk/instant_tests/models/web_transaction_instant_test_request.py

@@ -0,0 +1,236 @@
+# 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 datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from thousandeyes_sdk.instant_tests.models.test_agent import TestAgent
+from thousandeyes_sdk.instant_tests.models.test_auth_type import TestAuthType
+from thousandeyes_sdk.instant_tests.models.test_custom_headers import TestCustomHeaders
+from thousandeyes_sdk.instant_tests.models.test_links import TestLinks
+from thousandeyes_sdk.instant_tests.models.test_page_loading_strategy import TestPageLoadingStrategy
+from thousandeyes_sdk.instant_tests.models.test_path_trace_mode import TestPathTraceMode
+from thousandeyes_sdk.instant_tests.models.test_probe_mode import TestProbeMode
+from thousandeyes_sdk.instant_tests.models.test_protocol import TestProtocol
+from thousandeyes_sdk.instant_tests.models.test_ssl_version_id import TestSslVersionId
+from typing import Optional, Set
+from typing_extensions import Self
+
+class WebTransactionInstantTestRequest(BaseModel):
+    """
+    WebTransactionInstantTestRequest
+    """ # noqa: E501
+    created_by: Optional[StrictStr] = Field(default=None, description="User that created the test.", alias="createdBy")
+    created_date: Optional[datetime] = Field(default=None, description="UTC created date (ISO date-time format).", alias="createdDate")
+    description: Optional[StrictStr] = Field(default=None, description="A description of the test.")
+    live_share: Optional[StrictBool] = Field(default=None, description="Indicates if the test is shared with the account group.", alias="liveShare")
+    modified_by: Optional[StrictStr] = Field(default=None, description="User that modified the test.", alias="modifiedBy")
+    modified_date: Optional[datetime] = Field(default=None, description="UTC last modification date (ISO date-time format).", alias="modifiedDate")
+    saved_event: Optional[StrictBool] = Field(default=None, description="Indicates if the test is a saved event.", alias="savedEvent")
+    test_id: Optional[StrictStr] = Field(default=None, description="Each test is assigned an unique ID; this is used to access test information and results from other endpoints.", alias="testId")
+    test_name: Optional[StrictStr] = Field(default=None, description="The name of the test. Test name must be unique.", alias="testName")
+    type: Optional[StrictStr] = None
+    links: Optional[TestLinks] = Field(default=None, alias="_links")
+    labels: Optional[List[StrictStr]] = Field(default=None, description="A list of test label identifiers (get `labelId` from `/labels` endpoint).")
+    shared_with_accounts: Optional[List[StrictStr]] = Field(default=None, description="A list of account group identifiers that the test is shared with (get `aid` from `/account-groups` endpoint).", alias="sharedWithAccounts")
+    auth_type: Optional[TestAuthType] = Field(default=None, alias="authType")
+    bandwidth_measurements: Optional[StrictBool] = Field(default=None, description="Set to `true` to enable bandwidth measurements, only applies to Enterprise agents assigned to the test.", alias="bandwidthMeasurements")
+    client_certificate: Optional[StrictStr] = Field(default=None, description="String representation (containing newline characters) of client certificate, the private key must be placed first, then the certificate.", alias="clientCertificate")
+    content_regex: Optional[StrictStr] = Field(default=None, description="Verify content using a regular expression. This field does not require escaping.", alias="contentRegex")
+    custom_headers: Optional[TestCustomHeaders] = Field(default=None, alias="customHeaders")
+    desired_status_code: Optional[StrictStr] = Field(default='200', description="Specify the HTTP status code value that indicates a successful response.", alias="desiredStatusCode")
+    emulated_device_id: Optional[StrictStr] = Field(default=None, description="id of the emulated device, if one was given when the test was created", alias="emulatedDeviceId")
+    follow_redirects: Optional[StrictBool] = Field(default=True, description="To disable following HTTP/301 or HTTP/302 redirect directives, set this parameter to `false`.", alias="followRedirects")
+    http_target_time: Optional[Annotated[int, Field(le=5000, strict=True, ge=100)]] = Field(default=None, description="Target time for HTTP server completion, specified in milliseconds.", alias="httpTargetTime")
+    http_time_limit: Optional[Annotated[int, Field(le=60, strict=True, ge=5)]] = Field(default=5, description="HTTP time limit in seconds.", alias="httpTimeLimit")
+    http_version: Optional[Annotated[int, Field(le=2, strict=True, ge=1)]] = Field(default=2, description="HTTP protocol version. Set to '2' to prefer HTTP/2, or '1' to use only HTTP/1.1.", alias="httpVersion")
+    include_headers: Optional[StrictBool] = Field(default=True, description="Set to `true` to capture response headers for objects loaded by the test.", alias="includeHeaders")
+    mtu_measurements: Optional[StrictBool] = Field(default=None, description="Set `true` to measure MTU sizes on network from agents to the target.", alias="mtuMeasurements")
+    network_measurements: Optional[StrictBool] = Field(default=True, description="Enable or disable network measurements. Set to true to enable or false to disable network measurements.", alias="networkMeasurements")
+    num_path_traces: Optional[Annotated[int, Field(le=10, strict=True, ge=1)]] = Field(default=3, description="Number of path traces executed by the agent.", alias="numPathTraces")
+    password: Optional[StrictStr] = Field(default=None, description="Password for Basic/NTLM authentication.")
+    path_trace_mode: Optional[TestPathTraceMode] = Field(default=None, alias="pathTraceMode")
+    probe_mode: Optional[TestProbeMode] = Field(default=None, alias="probeMode")
+    protocol: Optional[TestProtocol] = None
+    ssl_version: Optional[StrictStr] = Field(default=None, description="Reflects the verbose SSL protocol version used by a test.", alias="sslVersion")
+    ssl_version_id: Optional[TestSslVersionId] = Field(default=None, alias="sslVersionId")
+    target_time: Optional[Annotated[int, Field(le=60, strict=True, ge=0)]] = Field(default=None, description="Target time for completion, defaults to 50% of time limit specified in seconds. (0 means default behavior)", alias="targetTime")
+    time_limit: Optional[Annotated[int, Field(le=180, strict=True, ge=5)]] = Field(default=30, description="Time limit for transaction in seconds.", alias="timeLimit")
+    transaction_script: StrictStr = Field(description="JavaScript of a web transaction test. Quotes must be escaped (precede \" characters with \\ ).", alias="transactionScript")
+    url: StrictStr = Field(description="Target for the test.")
+    use_ntlm: Optional[StrictBool] = Field(default=None, description="Set to true to use NTLM, false to use Basic Authentication. Requires username and password to be set.", alias="useNtlm")
+    user_agent: Optional[StrictStr] = Field(default=None, description="User-agent string to be provided during the test.", alias="userAgent")
+    username: Optional[StrictStr] = Field(default=None, description="Username for Basic/NTLM authentication.")
+    verify_certificate: Optional[StrictBool] = Field(default=False, description="Ignore or acknowledge certificate errors. Set to false to ignore certificate errors.", alias="verifyCertificate")
+    allow_unsafe_legacy_renegotiation: Optional[StrictBool] = Field(default=True, description="Allows TLS renegotiation with servers not supporting RFC 5746. Default Set to true to allow unsafe legacy renegotiation.", alias="allowUnsafeLegacyRenegotiation")
+    block_domains: Optional[StrictStr] = Field(default=None, description="Domains or full object URLs to be excluded from metrics and waterfall data for transaction tests.", alias="blockDomains")
+    disable_screenshot: Optional[StrictBool] = Field(default=False, description="Enables or disables screenshots on error. Set true to not capture", alias="disableScreenshot")
+    allow_mic_and_camera: Optional[StrictBool] = Field(default=False, description="Set true allow the use of a fake mic and camera in the browser.", alias="allowMicAndCamera")
+    allow_geolocation: Optional[StrictBool] = Field(default=False, description="Set true to use the agent’s geolocation by the web page.", alias="allowGeolocation")
+    browser_language: Optional[StrictStr] = Field(default=None, description="Set one of the available browser language that you want to use to configure the browser.", alias="browserLanguage")
+    page_loading_strategy: Optional[TestPageLoadingStrategy] = Field(default=None, alias="pageLoadingStrategy")
+    fixed_packet_rate: Optional[Annotated[int, Field(le=100, strict=True, ge=0)]] = Field(default=None, description="Sets packets rate sent to measure the network in packets per second.", alias="fixedPacketRate")
+    override_agent_proxy: Optional[StrictBool] = Field(default=False, description="Flag indicating if a proxy other than the default should be used. To override the default proxy for agents, set to `true` and specify a value for `overrideProxyId`.", alias="overrideAgentProxy")
+    override_proxy_id: Optional[StrictStr] = Field(default=None, description="ID of the proxy to be used if the default proxy is overridden.", alias="overrideProxyId")
+    agents: List[TestAgent] = Field(description="A list of objects with `agentId` (required) and `sourceIpAddress` (optional).")
+    credentials: Optional[List[StrictStr]] = Field(default=None, description="Contains a list of credential IDs (get `credentialId` from `/credentials` endpoint).")
+    __properties: ClassVar[List[str]] = ["createdBy", "createdDate", "description", "liveShare", "modifiedBy", "modifiedDate", "savedEvent", "testId", "testName", "type", "_links", "labels", "sharedWithAccounts", "authType", "bandwidthMeasurements", "clientCertificate", "contentRegex", "customHeaders", "desiredStatusCode", "emulatedDeviceId", "followRedirects", "httpTargetTime", "httpTimeLimit", "httpVersion", "includeHeaders", "mtuMeasurements", "networkMeasurements", "numPathTraces", "password", "pathTraceMode", "probeMode", "protocol", "sslVersion", "sslVersionId", "targetTime", "timeLimit", "transactionScript", "url", "useNtlm", "userAgent", "username", "verifyCertificate", "allowUnsafeLegacyRenegotiation", "blockDomains", "disableScreenshot", "allowMicAndCamera", "allowGeolocation", "browserLanguage", "pageLoadingStrategy", "fixedPacketRate", "overrideAgentProxy", "overrideProxyId", "agents", "credentials"]
+
+    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 WebTransactionInstantTestRequest 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.
+        * OpenAPI `readOnly` fields are excluded.
+        """
+        excluded_fields: Set[str] = set([
+            "created_by",
+            "created_date",
+            "live_share",
+            "modified_by",
+            "modified_date",
+            "saved_event",
+            "test_id",
+            "type",
+            "ssl_version",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # 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 custom_headers
+        if self.custom_headers:
+            _dict['customHeaders'] = self.custom_headers.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 WebTransactionInstantTestRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "createdBy": obj.get("createdBy"),
+            "createdDate": obj.get("createdDate"),
+            "description": obj.get("description"),
+            "liveShare": obj.get("liveShare"),
+            "modifiedBy": obj.get("modifiedBy"),
+            "modifiedDate": obj.get("modifiedDate"),
+            "savedEvent": obj.get("savedEvent"),
+            "testId": obj.get("testId"),
+            "testName": obj.get("testName"),
+            "type": obj.get("type"),
+            "_links": TestLinks.from_dict(obj["_links"]) if obj.get("_links") is not None else None,
+            "labels": obj.get("labels"),
+            "sharedWithAccounts": obj.get("sharedWithAccounts"),
+            "authType": obj.get("authType"),
+            "bandwidthMeasurements": obj.get("bandwidthMeasurements"),
+            "clientCertificate": obj.get("clientCertificate"),
+            "contentRegex": obj.get("contentRegex"),
+            "customHeaders": TestCustomHeaders.from_dict(obj["customHeaders"]) if obj.get("customHeaders") is not None else None,
+            "desiredStatusCode": obj.get("desiredStatusCode") if obj.get("desiredStatusCode") is not None else '200',
+            "emulatedDeviceId": obj.get("emulatedDeviceId"),
+            "followRedirects": obj.get("followRedirects") if obj.get("followRedirects") is not None else True,
+            "httpTargetTime": obj.get("httpTargetTime"),
+            "httpTimeLimit": obj.get("httpTimeLimit") if obj.get("httpTimeLimit") is not None else 5,
+            "httpVersion": obj.get("httpVersion") if obj.get("httpVersion") is not None else 2,
+            "includeHeaders": obj.get("includeHeaders") if obj.get("includeHeaders") is not None else True,
+            "mtuMeasurements": obj.get("mtuMeasurements"),
+            "networkMeasurements": obj.get("networkMeasurements") if obj.get("networkMeasurements") is not None else True,
+            "numPathTraces": obj.get("numPathTraces") if obj.get("numPathTraces") is not None else 3,
+            "password": obj.get("password"),
+            "pathTraceMode": obj.get("pathTraceMode"),
+            "probeMode": obj.get("probeMode"),
+            "protocol": obj.get("protocol"),
+            "sslVersion": obj.get("sslVersion"),
+            "sslVersionId": obj.get("sslVersionId"),
+            "targetTime": obj.get("targetTime"),
+            "timeLimit": obj.get("timeLimit") if obj.get("timeLimit") is not None else 30,
+            "transactionScript": obj.get("transactionScript"),
+            "url": obj.get("url"),
+            "useNtlm": obj.get("useNtlm"),
+            "userAgent": obj.get("userAgent"),
+            "username": obj.get("username"),
+            "verifyCertificate": obj.get("verifyCertificate") if obj.get("verifyCertificate") is not None else False,
+            "allowUnsafeLegacyRenegotiation": obj.get("allowUnsafeLegacyRenegotiation") if obj.get("allowUnsafeLegacyRenegotiation") is not None else True,
+            "blockDomains": obj.get("blockDomains"),
+            "disableScreenshot": obj.get("disableScreenshot") if obj.get("disableScreenshot") is not None else False,
+            "allowMicAndCamera": obj.get("allowMicAndCamera") if obj.get("allowMicAndCamera") is not None else False,
+            "allowGeolocation": obj.get("allowGeolocation") if obj.get("allowGeolocation") is not None else False,
+            "browserLanguage": obj.get("browserLanguage"),
+            "pageLoadingStrategy": obj.get("pageLoadingStrategy"),
+            "fixedPacketRate": obj.get("fixedPacketRate"),
+            "overrideAgentProxy": obj.get("overrideAgentProxy") if obj.get("overrideAgentProxy") is not None else False,
+            "overrideProxyId": obj.get("overrideProxyId"),
+            "agents": [TestAgent.from_dict(_item) for _item in obj["agents"]] if obj.get("agents") is not None else None,
+            "credentials": obj.get("credentials")
+        })
+        return _obj
+
+