mirror of
https://github.com/block/goose.git
synced 2026-07-17 12:56:20 +02:00
Douwe Osinga
102 lines
3.4 KiB
Python
102 lines
3.4 KiB
Python
# coding: utf-8
|
|
|
|
"""
|
|
goose-server
|
|
|
|
An AI agent
|
|
|
|
The version of the OpenAPI document: 1.9.0
|
|
Contact: ai-oss-tools@block.xyz
|
|
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
|
|
Do not edit the class manually.
|
|
""" # noqa: E501
|
|
|
|
|
|
from __future__ import annotations
|
|
import pprint
|
|
import re # noqa: F401
|
|
import json
|
|
|
|
from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr
|
|
from typing import Any, ClassVar, Dict, List, Optional
|
|
from typing import Optional, Set
|
|
from typing_extensions import Self
|
|
|
|
class ConfigKey(BaseModel):
|
|
"""
|
|
Configuration key metadata for provider setup
|
|
""" # noqa: E501
|
|
default: Optional[StrictStr] = Field(default=None, description="Optional default value for the key")
|
|
name: StrictStr = Field(description="The name of the configuration key (e.g., \"API_KEY\")")
|
|
oauth_flow: StrictBool = Field(description="Whether this key should be configured using OAuth device code flow When true, the provider's configure_oauth() method will be called instead of prompting for manual input")
|
|
required: StrictBool = Field(description="Whether this key is required for the provider to function")
|
|
secret: StrictBool = Field(description="Whether this key should be stored securely (e.g., in keychain)")
|
|
__properties: ClassVar[List[str]] = ["default", "name", "oauth_flow", "required", "secret"]
|
|
|
|
model_config = ConfigDict(
|
|
populate_by_name=True,
|
|
validate_assignment=True,
|
|
protected_namespaces=(),
|
|
)
|
|
|
|
|
|
def to_str(self) -> str:
|
|
"""Returns the string representation of the model using alias"""
|
|
return pprint.pformat(self.model_dump(by_alias=True))
|
|
|
|
def to_json(self) -> str:
|
|
"""Returns the JSON representation of the model using alias"""
|
|
# TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
|
|
return json.dumps(self.to_dict())
|
|
|
|
@classmethod
|
|
def from_json(cls, json_str: str) -> Optional[Self]:
|
|
"""Create an instance of ConfigKey from a JSON string"""
|
|
return cls.from_dict(json.loads(json_str))
|
|
|
|
def to_dict(self) -> Dict[str, Any]:
|
|
"""Return the dictionary representation of the model using alias.
|
|
|
|
This has the following differences from calling pydantic's
|
|
`self.model_dump(by_alias=True)`:
|
|
|
|
* `None` is only added to the output dict for nullable fields that
|
|
were set at model initialization. Other fields with value `None`
|
|
are ignored.
|
|
"""
|
|
excluded_fields: Set[str] = set([
|
|
])
|
|
|
|
_dict = self.model_dump(
|
|
by_alias=True,
|
|
exclude=excluded_fields,
|
|
exclude_none=True,
|
|
)
|
|
# set to None if default (nullable) is None
|
|
# and model_fields_set contains the field
|
|
if self.default is None and "default" in self.model_fields_set:
|
|
_dict['default'] = None
|
|
|
|
return _dict
|
|
|
|
@classmethod
|
|
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
|
|
"""Create an instance of ConfigKey from a dict"""
|
|
if obj is None:
|
|
return None
|
|
|
|
if not isinstance(obj, dict):
|
|
return cls.model_validate(obj)
|
|
|
|
_obj = cls.model_validate({
|
|
"default": obj.get("default"),
|
|
"name": obj.get("name"),
|
|
"oauth_flow": obj.get("oauth_flow"),
|
|
"required": obj.get("required"),
|
|
"secret": obj.get("secret")
|
|
})
|
|
return _obj
|
|
|
|
|