[GitHub Bot] Generated python SDK (#82)

Co-authored-by: API Team <api-team@thousandeyes.com>
This commit is contained in:
Miguel Pragosa 2024-11-20 08:28:16 +00:00 committed by GitHub
parent f235c99bfd
commit b9976c63ed
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
39 changed files with 61 additions and 47 deletions

View File

@ -12,7 +12,7 @@ This API provides the following operations to manage your organization:
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 7.0.26
- API version: 7.0.27
- Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

View File

@ -9,7 +9,8 @@ Name | Type | Description | Notes
**account_group_name** | **str** | Account group name | [optional]
**is_current_account_group** | **bool** | Indicates whether the requested aid is the context of the current account. | [optional]
**is_default_account_group** | **bool** | Indicates whether the aid is the default one for the requesting user. | [optional]
**organization_name** | **str** | (Optional) Indicates whether the aid is the default one for the requesting user. | [optional]
**organization_name** | **str** | (Optional) The name of the organization associated with the account group. | [optional]
**org_id** | **str** | (Optional) The ID for the organization associated with the account group. | [optional]
**users** | [**List[UserAccountGroup]**](UserAccountGroup.md) | | [optional]
**links** | [**SelfLinks**](SelfLinks.md) | | [optional]
**agents** | [**List[EnterpriseAgent]**](EnterpriseAgent.md) | | [optional]

View File

@ -9,7 +9,8 @@ Name | Type | Description | Notes
**account_group_name** | **str** | Account group name | [optional]
**is_current_account_group** | **bool** | Indicates whether the requested aid is the context of the current account. | [optional]
**is_default_account_group** | **bool** | Indicates whether the aid is the default one for the requesting user. | [optional]
**organization_name** | **str** | (Optional) Indicates whether the aid is the default one for the requesting user. | [optional]
**organization_name** | **str** | (Optional) The name of the organization associated with the account group. | [optional]
**org_id** | **str** | (Optional) The ID for the organization associated with the account group. | [optional]
## Example

View File

@ -9,7 +9,8 @@ Name | Type | Description | Notes
**account_group_name** | **str** | Account group name | [optional]
**is_current_account_group** | **bool** | Indicates whether the requested aid is the context of the current account. | [optional]
**is_default_account_group** | **bool** | Indicates whether the aid is the default one for the requesting user. | [optional]
**organization_name** | **str** | (Optional) Indicates whether the aid is the default one for the requesting user. | [optional]
**organization_name** | **str** | (Optional) The name of the organization associated with the account group. | [optional]
**org_id** | **str** | (Optional) The ID for the organization associated with the account group. | [optional]
**users** | [**List[UserAccountGroup]**](UserAccountGroup.md) | | [optional]
**links** | [**SelfLinks**](SelfLinks.md) | | [optional]

View File

@ -32,12 +32,13 @@ class AccountGroupDetail(BaseModel):
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) Indicates whether the aid is the default one for the requesting user.", alias="organizationName")
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", "users", "_links", "agents", "accountToken"]
__properties: ClassVar[List[str]] = ["aid", "accountGroupName", "isCurrentAccountGroup", "isDefaultAccountGroup", "organizationName", "orgId", "users", "_links", "agents", "accountToken"]
model_config = ConfigDict(
populate_by_name=True,
@ -113,6 +114,7 @@ class AccountGroupDetail(BaseModel):
"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,

View File

@ -29,8 +29,9 @@ class AccountGroupInfo(BaseModel):
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) Indicates whether the aid is the default one for the requesting user.", alias="organizationName")
__properties: ClassVar[List[str]] = ["aid", "accountGroupName", "isCurrentAccountGroup", "isDefaultAccountGroup", "organizationName"]
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")
__properties: ClassVar[List[str]] = ["aid", "accountGroupName", "isCurrentAccountGroup", "isDefaultAccountGroup", "organizationName", "orgId"]
model_config = ConfigDict(
populate_by_name=True,
@ -88,7 +89,8 @@ class AccountGroupInfo(BaseModel):
"accountGroupName": obj.get("accountGroupName"),
"isCurrentAccountGroup": obj.get("isCurrentAccountGroup"),
"isDefaultAccountGroup": obj.get("isDefaultAccountGroup"),
"organizationName": obj.get("organizationName")
"organizationName": obj.get("organizationName"),
"orgId": obj.get("orgId")
})
return _obj

View File

@ -31,10 +31,11 @@ class CreatedAccountGroup(BaseModel):
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) Indicates whether the aid is the default one for the requesting user.", alias="organizationName")
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")
__properties: ClassVar[List[str]] = ["aid", "accountGroupName", "isCurrentAccountGroup", "isDefaultAccountGroup", "organizationName", "users", "_links"]
__properties: ClassVar[List[str]] = ["aid", "accountGroupName", "isCurrentAccountGroup", "isDefaultAccountGroup", "organizationName", "orgId", "users", "_links"]
model_config = ConfigDict(
populate_by_name=True,
@ -103,6 +104,7 @@ class CreatedAccountGroup(BaseModel):
"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
})

View File

@ -59,6 +59,7 @@ class TestAccountGroupsApi(unittest.TestCase):
"accountGroupName" : "Account A",
"isDefaultAccountGroup" : true,
"aid" : "1234",
"orgId" : "12345",
"users" : [ {
"uid" : "235",
"lastLogin" : "2022-07-17T22:00:54Z",
@ -127,6 +128,7 @@ class TestAccountGroupsApi(unittest.TestCase):
"isDefaultAccountGroup" : true,
"accountToken" : "6j052y4vfgyuhefghue",
"aid" : "1234",
"orgId" : "12345",
"users" : [ {
"uid" : "235",
"lastLogin" : "2022-07-17T22:00:54Z",
@ -345,13 +347,15 @@ class TestAccountGroupsApi(unittest.TestCase):
"organizationName" : "organizationName",
"accountGroupName" : "Account A",
"isDefaultAccountGroup" : true,
"aid" : "1234"
"aid" : "1234",
"orgId" : "12345"
}, {
"isCurrentAccountGroup" : true,
"organizationName" : "organizationName",
"accountGroupName" : "Account A",
"isDefaultAccountGroup" : true,
"aid" : "1234"
"aid" : "1234",
"orgId" : "12345"
} ]
}"""
@ -391,6 +395,7 @@ class TestAccountGroupsApi(unittest.TestCase):
"isDefaultAccountGroup" : true,
"accountToken" : "6j052y4vfgyuhefghue",
"aid" : "1234",
"orgId" : "12345",
"users" : [ {
"uid" : "235",
"lastLogin" : "2022-07-17T22:00:54Z",

View File

@ -5,7 +5,7 @@ Manage all agents available to your account in ThousandEyes, including both Clou
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 7.0.26
- API version: 7.0.27
- Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

View File

@ -12,7 +12,7 @@ For more information about the alerts, see [Alerts](https://docs.thousandeyes.co
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 7.0.26
- API version: 7.0.27
- Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

View File

@ -9,7 +9,7 @@ For more information about monitors, see [Inside-Out BGP Visibility](https://doc
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 7.0.26
- API version: 7.0.27
- Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

View File

@ -13,7 +13,7 @@ For more information about credentials, see [Working With Secure Credentials](ht
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 7.0.26
- API version: 7.0.27
- Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

View File

@ -3,7 +3,7 @@ Manage ThousandEyes Dashboards.
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 7.0.26
- API version: 7.0.27
- Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

View File

@ -9,7 +9,7 @@ To access Emulation API operations, the following permissions are required:
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 7.0.26
- API version: 7.0.27
- Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

View File

@ -5,7 +5,7 @@ For more information about Endpoint Agents, see [Endpoint Agents](https://docs.t
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 7.0.26
- API version: 7.0.27
- Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

View File

@ -13,7 +13,7 @@ The URLs for these API test data endpoints are provided within the test definiti
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 7.0.26
- API version: 7.0.27
- Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

View File

@ -4,7 +4,7 @@ Manage labels applied to endpoint agents using this API.
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 7.0.26
- API version: 7.0.27
- Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

View File

@ -3,7 +3,7 @@ Retrieve results for scheduled and dynamic tests on endpoint agents.
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 7.0.26
- API version: 7.0.27
- Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

View File

@ -380,11 +380,11 @@ class TestRealUserEndpointTestResultsApi(unittest.TestCase):
"log" : {
"browser" : {
"name" : "Google Chrome",
"version" : "7.0.26.98"
"version" : "7.0.27.98"
},
"creator" : {
"name" : "ThousandEyes Endpoint Agent",
"version" : "7.0.26"
"version" : "7.0.27"
},
"entries" : [ {
"pageref" : "page_1",

View File

@ -5,7 +5,7 @@ Manage endpoint agent dynamic and scheduled tests using the Endpoint Tests API.
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 7.0.26
- API version: 7.0.27
- Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

View File

@ -12,7 +12,7 @@ With the Events API, you can perform the following tasks on the ThousandEyes pla
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 7.0.26
- API version: 7.0.27
- Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

View File

@ -8,7 +8,7 @@ The response does not include the immediate test results. Use the Test Results e
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 7.0.26
- API version: 7.0.27
- Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

View File

@ -14,7 +14,7 @@ For more information about Internet Insights, see the [Internet Insights](https:
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 7.0.26
- API version: 7.0.27
- Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

View File

@ -3,7 +3,7 @@ Creates a new test snapshot in ThousandEyes.
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 7.0.26
- API version: 7.0.27
- Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

View File

@ -15,7 +15,7 @@ For more information about ThousandEyes for OpenTelemetry, see the [documentatio
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 7.0.26
- API version: 7.0.27
- Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

View File

@ -1,6 +1,6 @@
# DataModelVersion
The version of the data model used in the data stream. When using `v1`: - The `signal` cannot be `trace`. Default: `v2`
The version of the data model used in the data stream. When using `v1`: - The `signal` cannot be `trace`.
## Properties

View File

@ -1,6 +1,6 @@
# EndpointType
The type of connection used to send data to the endpoint. Default: `grpc` **Note**: When using the `splunk-hec` 'type', the `EndpointType` must be `http`.
The type of connection used to send data to the endpoint. **Note**: When using the `splunk-hec` 'type', the `EndpointType` must be `http`.
## Properties

View File

@ -7,8 +7,8 @@ Splunk HEC configuration. This can only be configured when the `type` is `splunk
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**token** | **str** | The Splunk HEC &#x60;token&#x60;. This is a required field. | [optional]
**source** | **str** | The Splunk HEC &#x60;source&#x60;. This field is optional. Default: &#x60;ThousandEyesOTel&#x60; | [optional] [default to 'ThousandEyesOTel']
**source_type** | **str** | The Splunk HEC &#x60;sourceType&#x60;. This field is optional. Default: &#x60;ThousandEyesOTel&#x60; | [optional] [default to 'ThousandEyesOTel']
**source** | **str** | The Splunk HEC &#x60;source&#x60;. This field is optional. | [optional] [default to 'ThousandEyesOTel']
**source_type** | **str** | The Splunk HEC &#x60;sourceType&#x60;. This field is optional. | [optional] [default to 'ThousandEyesOTel']
**index** | **str** | The name of the Splunk HEC index where the event data will be stored. This field is optional. | [optional]
## Example

View File

@ -1,6 +1,6 @@
# Signal
The OpenTelemetry signal of the stream integration. When using `trace`: - `dataModelVersion` must be `v2`. Default: `metric`
The OpenTelemetry signal of the stream integration. When using `trace`: - `dataModelVersion` must be `v2`.
## Properties

View File

@ -1,6 +1,6 @@
# TestMatchDomain
The domain of the test to match.
The domain of the test to match. `cea` - Cloud and Enterprise Agent `endpoint` - Endpoint Agent
## Properties

View File

@ -19,7 +19,7 @@ from typing_extensions import Self
class DataModelVersion(str, Enum):
"""
The version of the data model used in the data stream. When using `v1`: - The `signal` cannot be `trace`. Default: `v2`
The version of the data model used in the data stream. When using `v1`: - The `signal` cannot be `trace`.
"""
"""

View File

@ -19,7 +19,7 @@ from typing_extensions import Self
class EndpointType(str, Enum):
"""
The type of connection used to send data to the endpoint. Default: `grpc` **Note**: When using the `splunk-hec` 'type', the `EndpointType` must be `http`.
The type of connection used to send data to the endpoint. **Note**: When using the `splunk-hec` 'type', the `EndpointType` must be `http`.
"""
"""

View File

@ -26,8 +26,8 @@ class ExporterConfigSplunkHec(BaseModel):
Splunk HEC configuration. This can only be configured when the `type` is `splunk-hec`.
""" # noqa: E501
token: Optional[StrictStr] = Field(default=None, description="The Splunk HEC `token`. This is a required field.")
source: Optional[StrictStr] = Field(default='ThousandEyesOTel', description="The Splunk HEC `source`. This field is optional. Default: `ThousandEyesOTel`")
source_type: Optional[StrictStr] = Field(default='ThousandEyesOTel', description="The Splunk HEC `sourceType`. This field is optional. Default: `ThousandEyesOTel`", alias="sourceType")
source: Optional[StrictStr] = Field(default='ThousandEyesOTel', description="The Splunk HEC `source`. This field is optional.")
source_type: Optional[StrictStr] = Field(default='ThousandEyesOTel', description="The Splunk HEC `sourceType`. This field is optional.", alias="sourceType")
index: Optional[StrictStr] = Field(default=None, description="The name of the Splunk HEC index where the event data will be stored. This field is optional.")
__properties: ClassVar[List[str]] = ["token", "source", "sourceType", "index"]

View File

@ -19,7 +19,7 @@ from typing_extensions import Self
class Signal(str, Enum):
"""
The OpenTelemetry signal of the stream integration. When using `trace`: - `dataModelVersion` must be `v2`. Default: `metric`
The OpenTelemetry signal of the stream integration. When using `trace`: - `dataModelVersion` must be `v2`.
"""
"""

View File

@ -19,7 +19,7 @@ from typing_extensions import Self
class TestMatchDomain(str, Enum):
"""
The domain of the test to match.
The domain of the test to match. `cea` - Cloud and Enterprise Agent `endpoint` - Endpoint Agent
"""
"""

View File

@ -16,7 +16,7 @@ Things to note with the ThousandEyes Tags API:
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 7.0.26
- API version: 7.0.27
- Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

View File

@ -3,7 +3,7 @@ Get test result metrics for Cloud and Enterprise Agent tests.
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 7.0.26
- API version: 7.0.27
- Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

View File

@ -4,7 +4,7 @@ This API supports listing, creating, editing, and deleting Cloud and Enterprise
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 7.0.26
- API version: 7.0.27
- Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

View File

@ -17,7 +17,7 @@ Refer to the Usage API operations for detailed usage instructions and optional p
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 7.0.26
- API version: 7.0.27
- Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator