Skip to content

README.md

Latest commit

 

History

History
142 lines (91 loc) · 6.55 KB

README.md

File metadata and controls

142 lines (91 loc) · 6.55 KB
Raw

Environment

Overview

Available Operations

create_unified_environment

Create new environments

Example Usage

from unified_python_sdk import UnifiedTo
from unified_python_sdk.models import shared


with UnifiedTo(
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
) as unified_to:

    res = unified_to.environment.create_unified_environment(request=[])

    assert res.environments is not None

    # Handle response
    print(res.environments)

Parameters

Parameter Type Required Description
request List[str] ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.CreateUnifiedEnvironmentResponse

Errors

Error Type Status Code Content Type
errors.SDKError 4XX, 5XX */*

list_unified_environments

Returns all environments

Example Usage

from unified_python_sdk import UnifiedTo
from unified_python_sdk.models import shared


with UnifiedTo(
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
) as unified_to:

    res = unified_to.environment.list_unified_environments()

    assert res.environments is not None

    # Handle response
    print(res.environments)

Parameters

Parameter Type Required Description
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.ListUnifiedEnvironmentsResponse

Errors

Error Type Status Code Content Type
errors.SDKError 4XX, 5XX */*

remove_unified_environment

Remove an environment

Example Usage

from unified_python_sdk import UnifiedTo
from unified_python_sdk.models import shared


with UnifiedTo(
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
) as unified_to:

    res = unified_to.environment.remove_unified_environment(request={
        "env": "<value>",
    })

    assert res.environments is not None

    # Handle response
    print(res.environments)

Parameters

Parameter Type Required Description
request operations.RemoveUnifiedEnvironmentRequest ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.RemoveUnifiedEnvironmentResponse

Errors

Error Type Status Code Content Type
errors.SDKError 4XX, 5XX */*