fix: map Field to ContractField to avoid pydantic issue

devopsarr · Feb 21, 2024 · 73829ad · 73829ad
1 parent ad221cc
commit 73829ad
Show file tree

Hide file tree

Showing 19 changed files with 80 additions and 35 deletions.
diff --git a/README.md b/README.md
@@ -343,6 +343,7 @@ Class | Method | HTTP request | Description
  - [CommandResult](docs/CommandResult.md)
  - [CommandStatus](docs/CommandStatus.md)
  - [CommandTrigger](docs/CommandTrigger.md)
+ - [ContractField](docs/ContractField.md)
  - [CustomFilterResource](docs/CustomFilterResource.md)
  - [CustomFormatResource](docs/CustomFormatResource.md)
  - [CustomFormatSpecificationSchema](docs/CustomFormatSpecificationSchema.md)
@@ -360,7 +361,6 @@ Class | Method | HTTP request | Description
  - [EpisodeResourcePagingResource](docs/EpisodeResourcePagingResource.md)
  - [EpisodeTitleRequiredType](docs/EpisodeTitleRequiredType.md)
  - [EpisodesMonitoredResource](docs/EpisodesMonitoredResource.md)
- - [Field](docs/Field.md)
  - [FileDateType](docs/FileDateType.md)
  - [HealthCheckResult](docs/HealthCheckResult.md)
  - [HealthResource](docs/HealthResource.md)

diff --git a/docs/AutoTaggingSpecificationSchema.md b/docs/AutoTaggingSpecificationSchema.md
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 **implementation_name** | **str** |  | [optional] 
 **negate** | **bool** |  | [optional] 
 **required** | **bool** |  | [optional] 
-**fields** | [**List[Field]**](Field.md) |  | [optional] 
+**fields** | [**List[ContractField]**](ContractField.md) |  | [optional] 
 
 ## Example
 

diff --git a/docs/ContractField.md b/docs/ContractField.md
@@ -0,0 +1,45 @@
+# ContractField
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**order** | **int** |  | [optional] 
+**name** | **str** |  | [optional] 
+**label** | **str** |  | [optional] 
+**unit** | **str** |  | [optional] 
+**help_text** | **str** |  | [optional] 
+**help_text_warning** | **str** |  | [optional] 
+**help_link** | **str** |  | [optional] 
+**value** | **object** |  | [optional] 
+**type** | **str** |  | [optional] 
+**advanced** | **bool** |  | [optional] 
+**select_options** | [**List[SelectOption]**](SelectOption.md) |  | [optional] 
+**select_options_provider_action** | **str** |  | [optional] 
+**section** | **str** |  | [optional] 
+**hidden** | **str** |  | [optional] 
+**privacy** | [**PrivacyLevel**](PrivacyLevel.md) |  | [optional] 
+**placeholder** | **str** |  | [optional] 
+**is_float** | **bool** |  | [optional] 
+
+## Example
+
+```python
+from sonarr.models.contract_field import ContractField
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of ContractField from a JSON string
+contract_field_instance = ContractField.from_json(json)
+# print the JSON string representation of the object
+print ContractField.to_json()
+
+# convert the object into a dict
+contract_field_dict = contract_field_instance.to_dict()
+# create an instance of ContractField from a dict
+contract_field_form_dict = contract_field.from_dict(contract_field_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/CustomFormatSpecificationSchema.md b/docs/CustomFormatSpecificationSchema.md
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
 **info_link** | **str** |  | [optional] 
 **negate** | **bool** |  | [optional] 
 **required** | **bool** |  | [optional] 
-**fields** | [**List[Field]**](Field.md) |  | [optional] 
+**fields** | [**List[ContractField]**](ContractField.md) |  | [optional] 
 **presets** | [**List[CustomFormatSpecificationSchema]**](CustomFormatSpecificationSchema.md) |  | [optional] 
 
 ## Example

diff --git a/docs/DownloadClientResource.md b/docs/DownloadClientResource.md
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **int** |  | [optional] 
 **name** | **str** |  | [optional] 
-**fields** | [**List[Field]**](Field.md) |  | [optional] 
+**fields** | [**List[ContractField]**](ContractField.md) |  | [optional] 
 **implementation_name** | **str** |  | [optional] 
 **implementation** | **str** |  | [optional] 
 **config_contract** | **str** |  | [optional] 

diff --git a/docs/ImportListResource.md b/docs/ImportListResource.md
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **int** |  | [optional] 
 **name** | **str** |  | [optional] 
-**fields** | [**List[Field]**](Field.md) |  | [optional] 
+**fields** | [**List[ContractField]**](ContractField.md) |  | [optional] 
 **implementation_name** | **str** |  | [optional] 
 **implementation** | **str** |  | [optional] 
 **config_contract** | **str** |  | [optional] 

diff --git a/docs/IndexerResource.md b/docs/IndexerResource.md
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **int** |  | [optional] 
 **name** | **str** |  | [optional] 
-**fields** | [**List[Field]**](Field.md) |  | [optional] 
+**fields** | [**List[ContractField]**](ContractField.md) |  | [optional] 
 **implementation_name** | **str** |  | [optional] 
 **implementation** | **str** |  | [optional] 
 **config_contract** | **str** |  | [optional] 

diff --git a/docs/MetadataResource.md b/docs/MetadataResource.md
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **int** |  | [optional] 
 **name** | **str** |  | [optional] 
-**fields** | [**List[Field]**](Field.md) |  | [optional] 
+**fields** | [**List[ContractField]**](ContractField.md) |  | [optional] 
 **implementation_name** | **str** |  | [optional] 
 **implementation** | **str** |  | [optional] 
 **config_contract** | **str** |  | [optional] 

diff --git a/docs/NotificationResource.md b/docs/NotificationResource.md
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **int** |  | [optional] 
 **name** | **str** |  | [optional] 
-**fields** | [**List[Field]**](Field.md) |  | [optional] 
+**fields** | [**List[ContractField]**](ContractField.md) |  | [optional] 
 **implementation_name** | **str** |  | [optional] 
 **implementation** | **str** |  | [optional] 
 **config_contract** | **str** |  | [optional] 

diff --git a/sonarr/__init__.py b/sonarr/__init__.py
@@ -115,6 +115,7 @@
 from sonarr.models.command_result import CommandResult
 from sonarr.models.command_status import CommandStatus
 from sonarr.models.command_trigger import CommandTrigger
+from sonarr.models.contract_field import ContractField
 from sonarr.models.custom_filter_resource import CustomFilterResource
 from sonarr.models.custom_format_resource import CustomFormatResource
 from sonarr.models.custom_format_specification_schema import CustomFormatSpecificationSchema
@@ -132,7 +133,6 @@
 from sonarr.models.episode_resource_paging_resource import EpisodeResourcePagingResource
 from sonarr.models.episode_title_required_type import EpisodeTitleRequiredType
 from sonarr.models.episodes_monitored_resource import EpisodesMonitoredResource
-from sonarr.models.field import Field
 from sonarr.models.file_date_type import FileDateType
 from sonarr.models.health_check_result import HealthCheckResult
 from sonarr.models.health_resource import HealthResource

diff --git a/sonarr/models/__init__.py b/sonarr/models/__init__.py
@@ -33,6 +33,7 @@
 from sonarr.models.command_result import CommandResult
 from sonarr.models.command_status import CommandStatus
 from sonarr.models.command_trigger import CommandTrigger
+from sonarr.models.contract_field import ContractField
 from sonarr.models.custom_filter_resource import CustomFilterResource
 from sonarr.models.custom_format_resource import CustomFormatResource
 from sonarr.models.custom_format_specification_schema import CustomFormatSpecificationSchema
@@ -50,7 +51,6 @@
 from sonarr.models.episode_resource_paging_resource import EpisodeResourcePagingResource
 from sonarr.models.episode_title_required_type import EpisodeTitleRequiredType
 from sonarr.models.episodes_monitored_resource import EpisodesMonitoredResource
-from sonarr.models.field import Field
 from sonarr.models.file_date_type import FileDateType
 from sonarr.models.health_check_result import HealthCheckResult
 from sonarr.models.health_resource import HealthResource

diff --git a/sonarr/models/auto_tagging_specification_schema.py b/sonarr/models/auto_tagging_specification_schema.py
@@ -19,7 +19,7 @@
 
 from pydantic import BaseModel, Field, StrictBool, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
-from sonarr.models.field import Field
+from sonarr.models.contract_field import ContractField
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -33,7 +33,7 @@ class AutoTaggingSpecificationSchema(BaseModel):
     implementation_name: Optional[StrictStr] = Field(default=None, alias="implementationName")
     negate: Optional[StrictBool] = None
     required: Optional[StrictBool] = None
-    fields: Optional[List[Field]] = None
+    fields: Optional[List[ContractField]] = None
     __properties: ClassVar[List[str]] = ["id", "name", "implementation", "implementationName", "negate", "required", "fields"]
 
     model_config = {
@@ -120,7 +120,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
             "implementationName": obj.get("implementationName"),
             "negate": obj.get("negate"),
             "required": obj.get("required"),
-            "fields": [Field.from_dict(_item) for _item in obj["fields"]] if obj.get("fields") is not None else None
+            "fields": [ContractField.from_dict(_item) for _item in obj["fields"]] if obj.get("fields") is not None else None
         })
         return _obj
 

diff --git a/sonarr/models/field.py → sonarr/models/contract_field.py b/sonarr/models/field.py → sonarr/models/contract_field.py
@@ -24,9 +24,9 @@
 from typing import Optional, Set
 from typing_extensions import Self
 
-class Field(BaseModel):
+class ContractField(BaseModel):
     """
-    Field
+    ContractField
     """ # noqa: E501
     order: Optional[StrictInt] = None
     name: Optional[StrictStr] = None
@@ -65,7 +65,7 @@ def to_json(self) -> str:
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of Field from a JSON string"""
+        """Create an instance of ContractField from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -162,7 +162,7 @@ def to_dict(self) -> Dict[str, Any]:
 
     @classmethod
     def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of Field from a dict"""
+        """Create an instance of ContractField from a dict"""
         if obj is None:
             return None
 

diff --git a/sonarr/models/custom_format_specification_schema.py b/sonarr/models/custom_format_specification_schema.py
@@ -19,7 +19,7 @@
 
 from pydantic import BaseModel, Field, StrictBool, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
-from sonarr.models.field import Field
+from sonarr.models.contract_field import ContractField
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -34,7 +34,7 @@ class CustomFormatSpecificationSchema(BaseModel):
     info_link: Optional[StrictStr] = Field(default=None, alias="infoLink")
     negate: Optional[StrictBool] = None
     required: Optional[StrictBool] = None
-    fields: Optional[List[Field]] = None
+    fields: Optional[List[ContractField]] = None
     presets: Optional[List[CustomFormatSpecificationSchema]] = None
     __properties: ClassVar[List[str]] = ["id", "name", "implementation", "implementationName", "infoLink", "negate", "required", "fields", "presets"]
 
@@ -140,7 +140,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
             "infoLink": obj.get("infoLink"),
             "negate": obj.get("negate"),
             "required": obj.get("required"),
-            "fields": [Field.from_dict(_item) for _item in obj["fields"]] if obj.get("fields") is not None else None,
+            "fields": [ContractField.from_dict(_item) for _item in obj["fields"]] if obj.get("fields") is not None else None,
             "presets": [CustomFormatSpecificationSchema.from_dict(_item) for _item in obj["presets"]] if obj.get("presets") is not None else None
         })
         return _obj

diff --git a/sonarr/models/download_client_resource.py b/sonarr/models/download_client_resource.py
@@ -19,8 +19,8 @@
 
 from pydantic import BaseModel, Field, StrictBool, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
+from sonarr.models.contract_field import ContractField
 from sonarr.models.download_protocol import DownloadProtocol
-from sonarr.models.field import Field
 from sonarr.models.provider_message import ProviderMessage
 from typing import Optional, Set
 from typing_extensions import Self
@@ -31,7 +31,7 @@ class DownloadClientResource(BaseModel):
     """ # noqa: E501
     id: Optional[StrictInt] = None
     name: Optional[StrictStr] = None
-    fields: Optional[List[Field]] = None
+    fields: Optional[List[ContractField]] = None
     implementation_name: Optional[StrictStr] = Field(default=None, alias="implementationName")
     implementation: Optional[StrictStr] = None
     config_contract: Optional[StrictStr] = Field(default=None, alias="configContract")
@@ -156,7 +156,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
         _obj = cls.model_validate({
             "id": obj.get("id"),
             "name": obj.get("name"),
-            "fields": [Field.from_dict(_item) for _item in obj["fields"]] if obj.get("fields") is not None else None,
+            "fields": [ContractField.from_dict(_item) for _item in obj["fields"]] if obj.get("fields") is not None else None,
             "implementationName": obj.get("implementationName"),
             "implementation": obj.get("implementation"),
             "configContract": obj.get("configContract"),

diff --git a/sonarr/models/import_list_resource.py b/sonarr/models/import_list_resource.py
@@ -19,7 +19,7 @@
 
 from pydantic import BaseModel, Field, StrictBool, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
-from sonarr.models.field import Field
+from sonarr.models.contract_field import ContractField
 from sonarr.models.import_list_type import ImportListType
 from sonarr.models.monitor_types import MonitorTypes
 from sonarr.models.new_item_monitor_types import NewItemMonitorTypes
@@ -34,7 +34,7 @@ class ImportListResource(BaseModel):
     """ # noqa: E501
     id: Optional[StrictInt] = None
     name: Optional[StrictStr] = None
-    fields: Optional[List[Field]] = None
+    fields: Optional[List[ContractField]] = None
     implementation_name: Optional[StrictStr] = Field(default=None, alias="implementationName")
     implementation: Optional[StrictStr] = None
     config_contract: Optional[StrictStr] = Field(default=None, alias="configContract")
@@ -170,7 +170,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
         _obj = cls.model_validate({
             "id": obj.get("id"),
             "name": obj.get("name"),
-            "fields": [Field.from_dict(_item) for _item in obj["fields"]] if obj.get("fields") is not None else None,
+            "fields": [ContractField.from_dict(_item) for _item in obj["fields"]] if obj.get("fields") is not None else None,
             "implementationName": obj.get("implementationName"),
             "implementation": obj.get("implementation"),
             "configContract": obj.get("configContract"),

diff --git a/sonarr/models/indexer_resource.py b/sonarr/models/indexer_resource.py
@@ -19,8 +19,8 @@
 
 from pydantic import BaseModel, Field, StrictBool, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
+from sonarr.models.contract_field import ContractField
 from sonarr.models.download_protocol import DownloadProtocol
-from sonarr.models.field import Field
 from sonarr.models.provider_message import ProviderMessage
 from typing import Optional, Set
 from typing_extensions import Self
@@ -31,7 +31,7 @@ class IndexerResource(BaseModel):
     """ # noqa: E501
     id: Optional[StrictInt] = None
     name: Optional[StrictStr] = None
-    fields: Optional[List[Field]] = None
+    fields: Optional[List[ContractField]] = None
     implementation_name: Optional[StrictStr] = Field(default=None, alias="implementationName")
     implementation: Optional[StrictStr] = None
     config_contract: Optional[StrictStr] = Field(default=None, alias="configContract")
@@ -160,7 +160,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
         _obj = cls.model_validate({
             "id": obj.get("id"),
             "name": obj.get("name"),
-            "fields": [Field.from_dict(_item) for _item in obj["fields"]] if obj.get("fields") is not None else None,
+            "fields": [ContractField.from_dict(_item) for _item in obj["fields"]] if obj.get("fields") is not None else None,
             "implementationName": obj.get("implementationName"),
             "implementation": obj.get("implementation"),
             "configContract": obj.get("configContract"),

diff --git a/sonarr/models/metadata_resource.py b/sonarr/models/metadata_resource.py
@@ -19,7 +19,7 @@
 
 from pydantic import BaseModel, Field, StrictBool, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
-from sonarr.models.field import Field
+from sonarr.models.contract_field import ContractField
 from sonarr.models.provider_message import ProviderMessage
 from typing import Optional, Set
 from typing_extensions import Self
@@ -30,7 +30,7 @@ class MetadataResource(BaseModel):
     """ # noqa: E501
     id: Optional[StrictInt] = None
     name: Optional[StrictStr] = None
-    fields: Optional[List[Field]] = None
+    fields: Optional[List[ContractField]] = None
     implementation_name: Optional[StrictStr] = Field(default=None, alias="implementationName")
     implementation: Optional[StrictStr] = None
     config_contract: Optional[StrictStr] = Field(default=None, alias="configContract")
@@ -151,7 +151,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
         _obj = cls.model_validate({
             "id": obj.get("id"),
             "name": obj.get("name"),
-            "fields": [Field.from_dict(_item) for _item in obj["fields"]] if obj.get("fields") is not None else None,
+            "fields": [ContractField.from_dict(_item) for _item in obj["fields"]] if obj.get("fields") is not None else None,
             "implementationName": obj.get("implementationName"),
             "implementation": obj.get("implementation"),
             "configContract": obj.get("configContract"),

diff --git a/sonarr/models/notification_resource.py b/sonarr/models/notification_resource.py
@@ -19,7 +19,7 @@
 
 from pydantic import BaseModel, Field, StrictBool, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
-from sonarr.models.field import Field
+from sonarr.models.contract_field import ContractField
 from sonarr.models.provider_message import ProviderMessage
 from typing import Optional, Set
 from typing_extensions import Self
@@ -30,7 +30,7 @@ class NotificationResource(BaseModel):
     """ # noqa: E501
     id: Optional[StrictInt] = None
     name: Optional[StrictStr] = None
-    fields: Optional[List[Field]] = None
+    fields: Optional[List[ContractField]] = None
     implementation_name: Optional[StrictStr] = Field(default=None, alias="implementationName")
     implementation: Optional[StrictStr] = None
     config_contract: Optional[StrictStr] = Field(default=None, alias="configContract")
@@ -187,7 +187,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
         _obj = cls.model_validate({
             "id": obj.get("id"),
             "name": obj.get("name"),
-            "fields": [Field.from_dict(_item) for _item in obj["fields"]] if obj.get("fields") is not None else None,
+            "fields": [ContractField.from_dict(_item) for _item in obj["fields"]] if obj.get("fields") is not None else None,
             "implementationName": obj.get("implementationName"),
             "implementation": obj.get("implementation"),
             "configContract": obj.get("configContract"),