SAMProvider

SAM model of the Provider 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.provider.SAMDependency(*, kind: str, name: str, **extra_data: Any)

Bases: SAMModel

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

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.

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.provider.SAMProviderMetadata(*, 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)

Bases: SAMModel

Smarter API Provider Manifest - 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.provider.SAMProviderSpecProvider(*, api_key: str | None = None, base_url: str | None = None, connectivity_test_path: str | None = '', contact_email: EmailStr | None = None, description: str | None = None, docs_url: str | None = None, logo: str | None = None, name: str, privacy_policy_url: str | None = None, support_email: EmailStr | None = None, terms_of_service_url: str | None = None, website_url: str | None = None, **extra_data: Any)

Bases: SAMModel

Smarter API - generic API Connection class.

api_key: str | None

The name of the Smarter Secret containing the API key to use for verification tests.

base_url: str | None

The base URL for the Provider’s API.

connectivity_test_path: str | None

The URL path to test connectivity with the Provider’s API.

contact_email: EmailStr | None

The contact email of the Provider.

description: str | None

A brief description of the Provider.

docs_url: str | None

The documentation URL of the Provider.

logo: str | None

The logo of the Provider.

name: str

The name of the Provider.

Case sensitive. Must be unique and not empty, with no leading or trailing whitespace and no special characters. examples: ‘OpenAI’, ‘GoogleAI’, ‘MetaAI’.

privacy_policy_url: str | None

The privacy policy URL of the Provider.

support_email: EmailStr | None

The support email of the Provider.

terms_of_service_url: str | None

The terms of service URL of the Provider.

website_url: str | None

The website_url URL of the Provider.

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.provider.SAMProviderStatus(*, can_activate: bool | None = True, contact_email_verified: datetime | None = None, created: datetime, dependencies: list[SAMDependency] | None = None, is_active: bool, is_deprecated: bool, is_flagged: bool, is_suspended: bool, is_verified: bool, modified: datetime, ownership_requested: EmailStr | None = None, recordLocator: str, support_email_verified: datetime | None = None, tos_accepted_at: datetime | None = None, tos_accepted_by: EmailStr | None = None, **extra_data: Any)

Bases: SAMModel

Smarter API Provider Manifest - Status class.

can_activate: bool | None

Provider.status.can_activate: Indicates whether this Provider can be activated.

Read only.

contact_email_verified: datetime | None

Provider.status.contact_email_verified: The date in which the contact email for this Provider was verified.

Read only.

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].

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.

is_active: bool

Provider.status.is_active: Indicates whether this Provider is currently active. Read only.

is_deprecated: bool

Provider.status.is_deprecated: Indicates whether this Provider is deprecated.

Read only.

is_flagged: bool

Provider.status.is_flagged: Indicates whether this Provider has been flagged for review.

Read only.

is_suspended: bool

Provider.status.is_suspended: Indicates whether this Provider is currently suspended.

Read only.

is_verified: bool

Provider.status.is_verified: Indicates whether this Provider has been verified.

Read only.

modified: datetime

The date in which this resource was most recently changed.

Read only.

ownership_requested: EmailStr | None

Provider.status.ownership_requested: The Smarter user that has requested ownership of this Provider.

Read only.

recordLocator: str

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

Read only.

support_email_verified: datetime | None

Provider.status.support_email_verified: The date in which the support email for this Provider was verified.

Read only.

tos_accepted_at: datetime | None

Provider.status.tos_accepted_at: The date in which the Terms of Service for this Provider were accepted.

Read only.

tos_accepted_by: EmailStr | None

Provider.status.tos_accepted_by: The Smarter user that accepted the Terms of Service for this Provider.

Read only.

class smarter.models.sam.provider.SAMProviderSpec(*, provider: SAMProviderSpecProvider, **extra_data: Any)

Bases: SAMModel

Smarter API Api Connection Manifest ApiConnection.spec.

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].

provider: SAMProviderSpecProvider

Provider.spec.selector[obj]: the spec for the Provider.

class smarter.models.sam.provider.SAMProvider(*, apiVersion: str, kind: str, metadata: SAMProviderMetadata, spec: SAMProviderSpec, status: SAMProviderStatus | None = None, **extra_data: Any)

Bases: SAMModel

Smarter API Manifest - Account.

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: SAMProviderMetadata

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

spec: SAMProviderSpec

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

status: SAMProviderStatus | None

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

Stateful status information about the Provider.