SAMApiConnection

SAM model of the ApiConnection kind, generated from the Smarter platform’s JSON Schema.

Do not edit: run scripts/generate_sam_models.py. See smarter.models.sam.

class smarter.models.sam.apiconnection.ApiConnection(*, apiKey: str | None = None, authMethod: str | None = 'none', baseUrl: str, proxyHost: str | None = None, proxyPassword: str | None = None, proxyPort: int | None = None, proxyProtocol: str | None = None, proxyUsername: str | None = None, timeout: Annotated[int, None, Interval(gt=None, ge=1, lt=None, le=None), None] | None = 30, **extra_data: Any)[source]

Bases: SAMModel

Smarter API - generic API Connection class.

apiKey: str | None

The API key for authentication, if required.

authMethod: str | None

The authentication method to use.

Example: ‘Basic Auth’, ‘Token Auth’.

baseUrl: str

The root domain of the API.

Example: ‘https://api.example.com’.

proxyHost: str | None

The remote host of the proxy connection.

proxyPassword: str | None

The password for the proxy connection.

proxyPort: int | None

The port of the proxy connection.

proxyProtocol: str | None

The protocol of the proxy connection.

Example: ‘http’, ‘https’.

proxyUsername: str | None

The username for the proxy connection.

timeout: conint(ge=1) | None

The timeout for the API request in seconds.

Default is 30 seconds.

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}

Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].

class smarter.models.sam.apiconnection.SAMApiConnectionSpec(*, connection: ApiConnection, **extra_data: Any)[source]

Bases: SAMModel

Smarter API Api Connection Manifest ApiConnection.spec.

connection: ApiConnection

ApiConnection.spec.selector[obj]: the selector logic to use for the ApiConnection.

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}

Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].

class smarter.models.sam.apiconnection.SAMConnectionCommonMetadata(*, annotations: None | list[dict[str, str | int | float | bool | date | datetime | UUID | bytes | list | dict[str, Any]]] = None, description: str | None, name: str, tags: list[str] | None = None, version: str | None, **extra_data: Any)[source]

Bases: SAMModel

Smarter API Connection Manifest - common Metadata class.

annotations: None | list[dict[str, str | int | float | bool | date | datetime | UUID | bytes | list | dict[str, Any]]]

The manifest annotations.

Used for storing arbitrary metadata as

key-value pairs. Example: [{‘smarter.sh/test-manifest/project-name’: ‘Scooby dooby do’}]. The key should be a valid url-friendly string. The value accepts multi-line string values (YAML block scalars) and various scalar types including str, int, float, bool, datetime.date, datetime.datetime, decimal.Decimal, uuid.UUID, bytes, list, dict.

description: str | None

The description for this resource.

Be brief. Keep it under 255 characters.

name: str

The camelCase name of the manifest resource.

tags: list[str] | None

The tags of the manifest.

Used for generic resource categorization and search. Example: [‘tag1’, ‘tag2’]

version: str | None

The semantic version of the manifest.

Example: 0.1.0

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}

Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].

class smarter.models.sam.apiconnection.SAMDependency(*, kind: str, name: str, **extra_data: Any)[source]

Bases: SAMModel

A resource that depends on the resource that a manifest describes.

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}

Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].

kind: str

Kind[String]: The SAM kind of the resource that depends on this resource, e.g. LLMClient.

Read only.

name: str

Name[String]: The name of the resource that depends on this resource.

Read only.

class smarter.models.sam.apiconnection.SAMConnectionCommonStatus(*, account_number: str, created: datetime, dependencies: list[SAMDependency] | None = None, modified: datetime, recordLocator: str, username: str, **extra_data: Any)[source]

Bases: SAMModel

Smarter API Connection Manifest - Status class.

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}

Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].

account_number: str

Connection.status.account_number: The account owner of this Connection.

Read only.

created: datetime

The date in which this resource was created.

Read only.

dependencies: list[SAMDependency] | None

Dependencies[List]: The resources that depend on this resource, and that must be deleted, or stop referring to it, before it can be deleted.

Lists only the resources that you can read. Read only.

modified: datetime

The date in which this resource was most recently changed.

Read only.

recordLocator: str

RecordLocator[String]: An optional identifier used to locate the resource record associated with this manifest.

Read only.

username: str

Connection.status.username: The Smarter user who created this Connection.

Read only.

class smarter.models.sam.apiconnection.SAMApiConnection(*, apiVersion: str, kind: str, metadata: SAMConnectionCommonMetadata, spec: SAMApiConnectionSpec, status: SAMConnectionCommonStatus | None = None, **extra_data: Any)[source]

Bases: SAMModel

Smarter API Connection Manifest - ApiConnection Model.

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}

Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].

apiVersion: str

ApiVersion[String]: Required.

The API version of the AbstractSAMBase.

kind: str

Kind[String]: Required.

The kind of resource described by the manifest.

metadata: SAMConnectionCommonMetadata

Connection.metadata[obj]: Required, the Connection metadata.

spec: SAMApiConnectionSpec

ApiConnection.spec[obj]: Required, the ApiConnection specification.

status: SAMConnectionCommonStatus | None

Connection.status[obj]: Optional, Read-only.

Stateful status information about the Connection.