finance_dev 0.9.0__py3-none-any.whl

finance_dev/models/ratingsaccuracy.py

@@ -0,0 +1,242 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: bb00be214710
+
+from __future__ import annotations
+from finance_dev.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
+from pydantic import model_serializer
+from typing_extensions import NotRequired, TypedDict
+
+
+class RatingsAccuracyTypedDict(TypedDict):
+    r"""Analyst accuracy metrics. Fields use snake_case; some fields may be absent when empty."""
+
+    avg_return_1m: NotRequired[Nullable[float]]
+    r"""Average return of the analyst's ratings over a 1 month horizon."""
+    avg_return_1y: NotRequired[Nullable[float]]
+    r"""Average return of the analyst's ratings over a 1 year horizon."""
+    avg_return_2y: NotRequired[Nullable[float]]
+    r"""Average return of the analyst's ratings over a 2 years horizon."""
+    avg_return_3m: NotRequired[Nullable[float]]
+    r"""Average return of the analyst's ratings over a 3 months horizon."""
+    avg_return_3y: NotRequired[Nullable[float]]
+    r"""Average return of the analyst's ratings over a 3 years horizon."""
+    avg_return_9m: NotRequired[Nullable[float]]
+    r"""Average return of the analyst's ratings over a 9 months horizon."""
+    gain_count_1m: NotRequired[Nullable[int]]
+    r"""Number of the analyst's ratings that gained over a 1 month horizon."""
+    gain_count_1y: NotRequired[Nullable[int]]
+    r"""Number of the analyst's ratings that gained over a 1 year horizon."""
+    gain_count_2y: NotRequired[Nullable[int]]
+    r"""Number of the analyst's ratings that gained over a 2 years horizon."""
+    gain_count_3m: NotRequired[Nullable[int]]
+    r"""Number of the analyst's ratings that gained over a 3 months horizon."""
+    gain_count_3y: NotRequired[Nullable[int]]
+    r"""Number of the analyst's ratings that gained over a 3 years horizon."""
+    gain_count_9m: NotRequired[Nullable[int]]
+    r"""Number of the analyst's ratings that gained over a 9 months horizon."""
+    loss_count_1m: NotRequired[Nullable[int]]
+    r"""Number of the analyst's ratings that lost over a 1 month horizon."""
+    loss_count_1y: NotRequired[Nullable[int]]
+    r"""Number of the analyst's ratings that lost over a 1 year horizon."""
+    loss_count_2y: NotRequired[Nullable[int]]
+    r"""Number of the analyst's ratings that lost over a 2 years horizon."""
+    loss_count_3m: NotRequired[Nullable[int]]
+    r"""Number of the analyst's ratings that lost over a 3 months horizon."""
+    loss_count_3y: NotRequired[Nullable[int]]
+    r"""Number of the analyst's ratings that lost over a 3 years horizon."""
+    loss_count_9m: NotRequired[Nullable[int]]
+    r"""Number of the analyst's ratings that lost over a 9 months horizon."""
+    smart_score: NotRequired[Nullable[float]]
+    r"""Provider smart score for the analyst's overall rating accuracy."""
+    std_dev_return_1m: NotRequired[Nullable[float]]
+    r"""Standard deviation of returns of the analyst's ratings over a 1 month horizon."""
+    std_dev_return_1y: NotRequired[Nullable[float]]
+    r"""Standard deviation of returns of the analyst's ratings over a 1 year horizon."""
+    std_dev_return_2y: NotRequired[Nullable[float]]
+    r"""Standard deviation of returns of the analyst's ratings over a 2 years horizon."""
+    std_dev_return_3m: NotRequired[Nullable[float]]
+    r"""Standard deviation of returns of the analyst's ratings over a 3 months horizon."""
+    std_dev_return_3y: NotRequired[Nullable[float]]
+    r"""Standard deviation of returns of the analyst's ratings over a 3 years horizon."""
+    std_dev_return_9m: NotRequired[Nullable[float]]
+    r"""Standard deviation of returns of the analyst's ratings over a 9 months horizon."""
+    success_rate: NotRequired[Nullable[float]]
+    r"""Overall rate of successful ratings for the analyst."""
+    total_ratings: NotRequired[Nullable[int]]
+    r"""Total number of ratings used to compute the accuracy metrics."""
+
+
+class RatingsAccuracy(BaseModel):
+    r"""Analyst accuracy metrics. Fields use snake_case; some fields may be absent when empty."""
+
+    avg_return_1m: OptionalNullable[float] = UNSET
+    r"""Average return of the analyst's ratings over a 1 month horizon."""
+
+    avg_return_1y: OptionalNullable[float] = UNSET
+    r"""Average return of the analyst's ratings over a 1 year horizon."""
+
+    avg_return_2y: OptionalNullable[float] = UNSET
+    r"""Average return of the analyst's ratings over a 2 years horizon."""
+
+    avg_return_3m: OptionalNullable[float] = UNSET
+    r"""Average return of the analyst's ratings over a 3 months horizon."""
+
+    avg_return_3y: OptionalNullable[float] = UNSET
+    r"""Average return of the analyst's ratings over a 3 years horizon."""
+
+    avg_return_9m: OptionalNullable[float] = UNSET
+    r"""Average return of the analyst's ratings over a 9 months horizon."""
+
+    gain_count_1m: OptionalNullable[int] = UNSET
+    r"""Number of the analyst's ratings that gained over a 1 month horizon."""
+
+    gain_count_1y: OptionalNullable[int] = UNSET
+    r"""Number of the analyst's ratings that gained over a 1 year horizon."""
+
+    gain_count_2y: OptionalNullable[int] = UNSET
+    r"""Number of the analyst's ratings that gained over a 2 years horizon."""
+
+    gain_count_3m: OptionalNullable[int] = UNSET
+    r"""Number of the analyst's ratings that gained over a 3 months horizon."""
+
+    gain_count_3y: OptionalNullable[int] = UNSET
+    r"""Number of the analyst's ratings that gained over a 3 years horizon."""
+
+    gain_count_9m: OptionalNullable[int] = UNSET
+    r"""Number of the analyst's ratings that gained over a 9 months horizon."""
+
+    loss_count_1m: OptionalNullable[int] = UNSET
+    r"""Number of the analyst's ratings that lost over a 1 month horizon."""
+
+    loss_count_1y: OptionalNullable[int] = UNSET
+    r"""Number of the analyst's ratings that lost over a 1 year horizon."""
+
+    loss_count_2y: OptionalNullable[int] = UNSET
+    r"""Number of the analyst's ratings that lost over a 2 years horizon."""
+
+    loss_count_3m: OptionalNullable[int] = UNSET
+    r"""Number of the analyst's ratings that lost over a 3 months horizon."""
+
+    loss_count_3y: OptionalNullable[int] = UNSET
+    r"""Number of the analyst's ratings that lost over a 3 years horizon."""
+
+    loss_count_9m: OptionalNullable[int] = UNSET
+    r"""Number of the analyst's ratings that lost over a 9 months horizon."""
+
+    smart_score: OptionalNullable[float] = UNSET
+    r"""Provider smart score for the analyst's overall rating accuracy."""
+
+    std_dev_return_1m: OptionalNullable[float] = UNSET
+    r"""Standard deviation of returns of the analyst's ratings over a 1 month horizon."""
+
+    std_dev_return_1y: OptionalNullable[float] = UNSET
+    r"""Standard deviation of returns of the analyst's ratings over a 1 year horizon."""
+
+    std_dev_return_2y: OptionalNullable[float] = UNSET
+    r"""Standard deviation of returns of the analyst's ratings over a 2 years horizon."""
+
+    std_dev_return_3m: OptionalNullable[float] = UNSET
+    r"""Standard deviation of returns of the analyst's ratings over a 3 months horizon."""
+
+    std_dev_return_3y: OptionalNullable[float] = UNSET
+    r"""Standard deviation of returns of the analyst's ratings over a 3 years horizon."""
+
+    std_dev_return_9m: OptionalNullable[float] = UNSET
+    r"""Standard deviation of returns of the analyst's ratings over a 9 months horizon."""
+
+    success_rate: OptionalNullable[float] = UNSET
+    r"""Overall rate of successful ratings for the analyst."""
+
+    total_ratings: OptionalNullable[int] = UNSET
+    r"""Total number of ratings used to compute the accuracy metrics."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "avg_return_1m",
+                "avg_return_1y",
+                "avg_return_2y",
+                "avg_return_3m",
+                "avg_return_3y",
+                "avg_return_9m",
+                "gain_count_1m",
+                "gain_count_1y",
+                "gain_count_2y",
+                "gain_count_3m",
+                "gain_count_3y",
+                "gain_count_9m",
+                "loss_count_1m",
+                "loss_count_1y",
+                "loss_count_2y",
+                "loss_count_3m",
+                "loss_count_3y",
+                "loss_count_9m",
+                "smart_score",
+                "std_dev_return_1m",
+                "std_dev_return_1y",
+                "std_dev_return_2y",
+                "std_dev_return_3m",
+                "std_dev_return_3y",
+                "std_dev_return_9m",
+                "success_rate",
+                "total_ratings",
+            ]
+        )
+        nullable_fields = set(
+            [
+                "avg_return_1m",
+                "avg_return_1y",
+                "avg_return_2y",
+                "avg_return_3m",
+                "avg_return_3y",
+                "avg_return_9m",
+                "gain_count_1m",
+                "gain_count_1y",
+                "gain_count_2y",
+                "gain_count_3m",
+                "gain_count_3y",
+                "gain_count_9m",
+                "loss_count_1m",
+                "loss_count_1y",
+                "loss_count_2y",
+                "loss_count_3m",
+                "loss_count_3y",
+                "loss_count_9m",
+                "smart_score",
+                "std_dev_return_1m",
+                "std_dev_return_1y",
+                "std_dev_return_2y",
+                "std_dev_return_3m",
+                "std_dev_return_3y",
+                "std_dev_return_9m",
+                "success_rate",
+                "total_ratings",
+            ]
+        )
+        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))
+            is_nullable_and_explicitly_set = (
+                k in nullable_fields
+                and (self.__pydantic_fields_set__.intersection({n}))  # pylint: disable=no-member
+            )
+
+            if val != UNSET_SENTINEL:
+                if (
+                    val is not None
+                    or k not in optional_fields
+                    or is_nullable_and_explicitly_set
+                ):
+                    m[k] = val
+
+        return m

finance_dev/models/replaceconfigwatchlistsop.py

@@ -0,0 +1,40 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: d81d7c0ef2cb
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .watchlistresponse import WatchlistResponse, WatchlistResponseTypedDict
+from finance_dev.types import BaseModel, UNSET_SENTINEL
+import pydantic
+from pydantic import model_serializer
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class ReplaceConfigWatchlistsResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    watchlist_response: NotRequired[WatchlistResponseTypedDict]
+    r"""The full, resulting set of watchlists after the replace, in request order. Sending an empty array resets the user to a single new \"Default\" watchlist with no symbols."""
+
+
+class ReplaceConfigWatchlistsResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    watchlist_response: Optional[WatchlistResponse] = None
+    r"""The full, resulting set of watchlists after the replace, in request order. Sending an empty array resets the user to a single new \"Default\" watchlist with no symbols."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["WatchlistResponse"])
+        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

finance_dev/models/replaceorderop.py

@@ -0,0 +1,40 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: db287c1a339f
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .replaceordresponse import ReplaceOrdResponse, ReplaceOrdResponseTypedDict
+from finance_dev.types import BaseModel, UNSET_SENTINEL
+import pydantic
+from pydantic import model_serializer
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class ReplaceOrderResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    replace_ord_response: NotRequired[ReplaceOrdResponseTypedDict]
+    r"""Replace request submitted successfully"""
+
+
+class ReplaceOrderResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    replace_ord_response: Optional[ReplaceOrdResponse] = None
+    r"""Replace request submitted successfully"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["ReplaceOrdResponse"])
+        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