api.md

Shared Types

from miru_platform_sdk.types import PaginatedList

ConfigInstances

Types:

from miru_platform_sdk.types import ConfigInstance, InstanceContent, ConfigInstanceListResponse

Methods:

• client.config_instances.create(**params) -> ConfigInstance
• client.config_instances.retrieve(config_instance_id, **params) -> ConfigInstance
• client.config_instances.list(**params) -> ConfigInstanceListResponse
• client.config_instances.download(config_instance_id, **params) -> BinaryAPIResponse

ConfigSchemas

Types:

from miru_platform_sdk.types import ConfigSchema, ConfigSchemaList, SchemaDocument, SchemaLanguage

Methods:

• client.config_schemas.create(**params) -> ConfigSchema
• client.config_schemas.retrieve(config_schema_id, **params) -> ConfigSchema
• client.config_schemas.list(**params) -> ConfigSchemaList

ConfigTypes

Types:

from miru_platform_sdk.types import ConfigType, ConfigTypeListResponse

Methods:

• client.config_types.create(**params) -> ConfigType
• client.config_types.retrieve(config_type_id) -> ConfigType
• client.config_types.update(config_type_id, **params) -> ConfigType
• client.config_types.list(**params) -> ConfigTypeListResponse

Deployments

Types:

from miru_platform_sdk.types import Deployment, DeploymentList

Methods:

• client.deployments.create(**params) -> Deployment
• client.deployments.retrieve(deployment_id, **params) -> Deployment
• client.deployments.list(**params) -> DeploymentList
• client.deployments.archive(deployment_id, **params) -> Deployment
• client.deployments.deploy(deployment_id, **params) -> Deployment
• client.deployments.list_drifts(deployment_id, **params) -> DeploymentList

Devices

Types:

from miru_platform_sdk.types import Device, DeviceList, DevicePingResponse

Methods:

• client.devices.create(**params) -> Device
• client.devices.retrieve(device_id, **params) -> Device
• client.devices.update(device_id, **params) -> Device
• client.devices.list(**params) -> DeviceList
• client.devices.ping(device_id, **params) -> DevicePingResponse

ProvisioningTokens

Types:

from miru_platform_sdk.types import ProvisioningToken

Methods:

• client.provisioning_tokens.create() -> ProvisioningToken

GitCommits

Types:

from miru_platform_sdk.types import GitCommit, GitCommitList, GitCommitRef

Methods:

• client.git_commits.create(**params) -> GitCommit
• client.git_commits.retrieve(git_commit_id) -> GitCommit
• client.git_commits.list(**params) -> GitCommitList

Principal

Types:

from miru_platform_sdk.types import Principal

Methods:

• client.principal.self() -> Principal

Releases

Types:

from miru_platform_sdk.types import Release, ReleaseList

Methods:

• client.releases.create(**params) -> Release
• client.releases.retrieve(release_id, **params) -> Release
• client.releases.list(**params) -> ReleaseList