finance_dev 0.9.0__py3-none-any.whl

finance_dev/models/getfilingssimilarityindexop.py

@@ -0,0 +1,102 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: df7f93989b13
+
+from __future__ import annotations
+from .filingssimilarityindexresponse import (
+    FilingsSimilarityIndexResponse,
+    FilingsSimilarityIndexResponseTypedDict,
+)
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .reportingfrequency import ReportingFrequency
+from finance_dev import models
+from finance_dev.types import BaseModel, UNSET_SENTINEL
+from finance_dev.utils import FieldMetadata, QueryParamMetadata
+import pydantic
+from pydantic import field_serializer, model_serializer
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetFilingsSimilarityIndexRequestTypedDict(TypedDict):
+    symbol: NotRequired[str]
+    r"""Stock symbol, such as AAPL. Use it to narrow results to one company. Required when `cik` is not provided."""
+    cik: NotRequired[str]
+    r"""Central Index Key. Required when `symbol` is not provided."""
+    freq: NotRequired[ReportingFrequency]
+    r"""Reporting frequency filter. Use annual or quarterly when you want only one reporting cadence."""
+
+
+class GetFilingsSimilarityIndexRequest(BaseModel):
+    symbol: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Stock symbol, such as AAPL. Use it to narrow results to one company. Required when `cik` is not provided."""
+
+    cik: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Central Index Key. Required when `symbol` is not provided."""
+
+    freq: Annotated[
+        Optional[ReportingFrequency],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Reporting frequency filter. Use annual or quarterly when you want only one reporting cadence."""
+
+    @field_serializer("freq")
+    def serialize_freq(self, value):
+        if isinstance(value, str):
+            try:
+                return models.ReportingFrequency(value)
+            except ValueError:
+                return value
+        return value
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["symbol", "cik", "freq"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k, serialized.get(n))
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m
+
+
+class GetFilingsSimilarityIndexResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    filings_similarity_index_response: NotRequired[
+        FilingsSimilarityIndexResponseTypedDict
+    ]
+    r"""Filings similarity index."""
+
+
+class GetFilingsSimilarityIndexResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    filings_similarity_index_response: Optional[FilingsSimilarityIndexResponse] = None
+    r"""Filings similarity index."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["FilingsSimilarityIndexResponse"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k, serialized.get(n))
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m