finance_dev 0.9.0__py3-none-any.whl

finance_dev/models/getincomestatementsop.py

@@ -0,0 +1,564 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 972ceae407fc
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .incomestatementsresponse import (
+    IncomeStatementsResponse,
+    IncomeStatementsResponseTypedDict,
+)
+from datetime import date
+from finance_dev.types import BaseModel, UNSET_SENTINEL
+from finance_dev.utils import FieldMetadata, QueryParamMetadata
+import pydantic
+from pydantic import model_serializer
+from typing import Callable, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetIncomeStatementsRequestTypedDict(TypedDict):
+    cik: NotRequired[str]
+    r"""Exact SEC CIK company identifier. Use this when you need one specific SEC registrant."""
+    ciks: NotRequired[str]
+    r"""Comma-separated CIKs (maps to cik.any_of)"""
+    cik_after: NotRequired[str]
+    r"""CIK pagination lower bound. Returns records with CIK values greater than this value, excluding the value itself."""
+    cik_from: NotRequired[str]
+    r"""CIK greater than or equal (inclusive)"""
+    cik_before: NotRequired[str]
+    r"""CIK pagination upper bound. Returns records with CIK values less than this value, excluding the value itself."""
+    cik_to: NotRequired[str]
+    r"""CIK upper-bound filter. Returns records with CIK values less than or equal to this value."""
+    period_end: NotRequired[date]
+    r"""Exact fiscal period-end date filter. Use it to return statements for one reporting period."""
+    period_end_after: NotRequired[date]
+    r"""Fiscal period-end lower-bound filter. Returns records after this date, excluding the date itself."""
+    period_end_from: NotRequired[date]
+    r"""Fiscal period-end start filter. Returns records on or after this date."""
+    period_end_before: NotRequired[date]
+    r"""Fiscal period-end upper-bound filter. Returns records before this date, excluding the date itself."""
+    period_end_to: NotRequired[date]
+    r"""Fiscal period-end end filter. Returns records on or before this date."""
+    filing_date: NotRequired[date]
+    r"""Exact filing date filter. Use it to return filings submitted on one specific date."""
+    filing_date_after: NotRequired[date]
+    r"""Filing-date lower-bound filter. Returns records after this date, excluding the date itself."""
+    filing_date_from: NotRequired[date]
+    r"""Filing-date start filter. Returns records on or after this date."""
+    filing_date_before: NotRequired[date]
+    r"""Filing-date upper-bound filter. Returns records before this date, excluding the date itself."""
+    filing_date_to: NotRequired[date]
+    r"""Filing-date end filter. Returns records on or before this date."""
+    tickers: NotRequired[str]
+    r"""Ticker symbol filter. Enter a ticker such as AAPL to narrow results to one company."""
+    tickers_all_of: NotRequired[str]
+    r"""Ticker all-of filter. Return records that include all listed tickers."""
+    tickers_any_of: NotRequired[str]
+    r"""Ticker any-of filter. Return records that include at least one listed ticker."""
+    fiscal_year: NotRequired[float]
+    r"""Exact fiscal year filter. Use it to return statements for one reporting year."""
+    fiscal_year_above: NotRequired[float]
+    r"""Fiscal year greater than (exclusive)"""
+    fiscal_year_min: NotRequired[float]
+    r"""Fiscal year greater than or equal (inclusive)"""
+    fiscal_year_below: NotRequired[float]
+    r"""Fiscal-year upper-bound filter. Returns records before this fiscal year, excluding the year itself."""
+    fiscal_year_max: NotRequired[float]
+    r"""Fiscal year less than or equal (inclusive)"""
+    fiscal_quarter: NotRequired[float]
+    r"""Exact fiscal quarter filter. Use values such as 1, 2, 3, or 4 when supported."""
+    fiscal_quarter_above: NotRequired[float]
+    r"""Fiscal quarter greater than (exclusive)"""
+    fiscal_quarter_min: NotRequired[float]
+    r"""Fiscal quarter greater than or equal (inclusive)"""
+    fiscal_quarter_below: NotRequired[float]
+    r"""Fiscal quarter less than (exclusive)"""
+    fiscal_quarter_max: NotRequired[float]
+    r"""Fiscal quarter less than or equal (inclusive)"""
+    timeframe: NotRequired[str]
+    r"""Reporting timeframe (e.g. quarterly, annual)"""
+    timeframe_any_of: NotRequired[str]
+    r"""Timeframe any-of filter. Return records that match at least one listed timeframe."""
+    timeframe_after: NotRequired[str]
+    r"""Timeframe lower-bound filter. Returns records after this timeframe, excluding the value itself."""
+    timeframe_from: NotRequired[str]
+    r"""Timeframe greater than or equal (inclusive)"""
+    timeframe_before: NotRequired[str]
+    r"""Timeframe upper-bound filter. Returns records before this timeframe, excluding the value itself."""
+    timeframe_to: NotRequired[str]
+    r"""Timeframe less than or equal (inclusive)"""
+    max_ticker: NotRequired[str]
+    r"""Exact maximum ticker value from the statement record. Use only for provider-specific filtering."""
+    max_ticker_any_of: NotRequired[str]
+    r"""Max ticker any-of filter. Return records matching at least one listed maxTicker value."""
+    max_ticker_after: NotRequired[str]
+    r"""Max ticker greater than (exclusive)"""
+    max_ticker_from: NotRequired[str]
+    r"""Max ticker greater than or equal (inclusive)"""
+    max_ticker_before: NotRequired[str]
+    r"""Max ticker upper-bound filter. Returns records before this value, excluding the value itself."""
+    max_ticker_to: NotRequired[str]
+    r"""Max ticker less than or equal (inclusive)"""
+    min_ticker: NotRequired[str]
+    r"""Exact minimum ticker value from the statement record. Use only for provider-specific filtering."""
+    min_ticker_any_of: NotRequired[str]
+    r"""Min ticker any-of filter. Return records matching at least one listed minTicker value."""
+    min_ticker_after: NotRequired[str]
+    r"""Min ticker greater than (exclusive)"""
+    min_ticker_from: NotRequired[str]
+    r"""Min ticker greater than or equal (inclusive)"""
+    min_ticker_before: NotRequired[str]
+    r"""Min ticker upper-bound filter. Returns records before this value, excluding the value itself."""
+    min_ticker_to: NotRequired[str]
+    r"""Min ticker less than or equal (inclusive)"""
+    limit: NotRequired[int]
+    r"""Maximum number of results per page. Use smaller values for UI pages and larger values for exports within API limits."""
+    sort: NotRequired[str]
+    r"""A comma-separated list of sort columns. For each column, append `.asc` or `.desc` to specify direction. Defaults to `period_end.asc` when not specified."""
+    next: NotRequired[str]
+    r"""Pagination cursor from the previous response. Omit it on the first request, then send the returned cursor to fetch the next page."""
+
+
+class GetIncomeStatementsRequest(BaseModel):
+    cik: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Exact SEC CIK company identifier. Use this when you need one specific SEC registrant."""
+
+    ciks: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Comma-separated CIKs (maps to cik.any_of)"""
+
+    cik_after: Annotated[
+        Optional[str],
+        pydantic.Field(alias="cikAfter"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""CIK pagination lower bound. Returns records with CIK values greater than this value, excluding the value itself."""
+
+    cik_from: Annotated[
+        Optional[str],
+        pydantic.Field(alias="cikFrom"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""CIK greater than or equal (inclusive)"""
+
+    cik_before: Annotated[
+        Optional[str],
+        pydantic.Field(alias="cikBefore"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""CIK pagination upper bound. Returns records with CIK values less than this value, excluding the value itself."""
+
+    cik_to: Annotated[
+        Optional[str],
+        pydantic.Field(alias="cikTo"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""CIK upper-bound filter. Returns records with CIK values less than or equal to this value."""
+
+    period_end: Annotated[
+        Optional[date],
+        pydantic.Field(alias="periodEnd"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Exact fiscal period-end date filter. Use it to return statements for one reporting period."""
+
+    period_end_after: Annotated[
+        Optional[date],
+        pydantic.Field(alias="periodEndAfter"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Fiscal period-end lower-bound filter. Returns records after this date, excluding the date itself."""
+
+    period_end_from: Annotated[
+        Optional[date],
+        pydantic.Field(alias="periodEndFrom"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Fiscal period-end start filter. Returns records on or after this date."""
+
+    period_end_before: Annotated[
+        Optional[date],
+        pydantic.Field(alias="periodEndBefore"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Fiscal period-end upper-bound filter. Returns records before this date, excluding the date itself."""
+
+    period_end_to: Annotated[
+        Optional[date],
+        pydantic.Field(alias="periodEndTo"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Fiscal period-end end filter. Returns records on or before this date."""
+
+    filing_date: Annotated[
+        Optional[date],
+        pydantic.Field(alias="filingDate"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Exact filing date filter. Use it to return filings submitted on one specific date."""
+
+    filing_date_after: Annotated[
+        Optional[date],
+        pydantic.Field(alias="filingDateAfter"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Filing-date lower-bound filter. Returns records after this date, excluding the date itself."""
+
+    filing_date_from: Annotated[
+        Optional[date],
+        pydantic.Field(alias="filingDateFrom"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Filing-date start filter. Returns records on or after this date."""
+
+    filing_date_before: Annotated[
+        Optional[date],
+        pydantic.Field(alias="filingDateBefore"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Filing-date upper-bound filter. Returns records before this date, excluding the date itself."""
+
+    filing_date_to: Annotated[
+        Optional[date],
+        pydantic.Field(alias="filingDateTo"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Filing-date end filter. Returns records on or before this date."""
+
+    tickers: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Ticker symbol filter. Enter a ticker such as AAPL to narrow results to one company."""
+
+    tickers_all_of: Annotated[
+        Optional[str],
+        pydantic.Field(alias="tickersAllOf"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Ticker all-of filter. Return records that include all listed tickers."""
+
+    tickers_any_of: Annotated[
+        Optional[str],
+        pydantic.Field(alias="tickersAnyOf"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Ticker any-of filter. Return records that include at least one listed ticker."""
+
+    fiscal_year: Annotated[
+        Optional[float],
+        pydantic.Field(alias="fiscalYear"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Exact fiscal year filter. Use it to return statements for one reporting year."""
+
+    fiscal_year_above: Annotated[
+        Optional[float],
+        pydantic.Field(alias="fiscalYearAbove"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Fiscal year greater than (exclusive)"""
+
+    fiscal_year_min: Annotated[
+        Optional[float],
+        pydantic.Field(alias="fiscalYearMin"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Fiscal year greater than or equal (inclusive)"""
+
+    fiscal_year_below: Annotated[
+        Optional[float],
+        pydantic.Field(alias="fiscalYearBelow"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Fiscal-year upper-bound filter. Returns records before this fiscal year, excluding the year itself."""
+
+    fiscal_year_max: Annotated[
+        Optional[float],
+        pydantic.Field(alias="fiscalYearMax"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Fiscal year less than or equal (inclusive)"""
+
+    fiscal_quarter: Annotated[
+        Optional[float],
+        pydantic.Field(alias="fiscalQuarter"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Exact fiscal quarter filter. Use values such as 1, 2, 3, or 4 when supported."""
+
+    fiscal_quarter_above: Annotated[
+        Optional[float],
+        pydantic.Field(alias="fiscalQuarterAbove"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Fiscal quarter greater than (exclusive)"""
+
+    fiscal_quarter_min: Annotated[
+        Optional[float],
+        pydantic.Field(alias="fiscalQuarterMin"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Fiscal quarter greater than or equal (inclusive)"""
+
+    fiscal_quarter_below: Annotated[
+        Optional[float],
+        pydantic.Field(alias="fiscalQuarterBelow"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Fiscal quarter less than (exclusive)"""
+
+    fiscal_quarter_max: Annotated[
+        Optional[float],
+        pydantic.Field(alias="fiscalQuarterMax"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Fiscal quarter less than or equal (inclusive)"""
+
+    timeframe: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Reporting timeframe (e.g. quarterly, annual)"""
+
+    timeframe_any_of: Annotated[
+        Optional[str],
+        pydantic.Field(alias="timeframeAnyOf"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Timeframe any-of filter. Return records that match at least one listed timeframe."""
+
+    timeframe_after: Annotated[
+        Optional[str],
+        pydantic.Field(alias="timeframeAfter"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Timeframe lower-bound filter. Returns records after this timeframe, excluding the value itself."""
+
+    timeframe_from: Annotated[
+        Optional[str],
+        pydantic.Field(alias="timeframeFrom"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Timeframe greater than or equal (inclusive)"""
+
+    timeframe_before: Annotated[
+        Optional[str],
+        pydantic.Field(alias="timeframeBefore"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Timeframe upper-bound filter. Returns records before this timeframe, excluding the value itself."""
+
+    timeframe_to: Annotated[
+        Optional[str],
+        pydantic.Field(alias="timeframeTo"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Timeframe less than or equal (inclusive)"""
+
+    max_ticker: Annotated[
+        Optional[str],
+        pydantic.Field(alias="maxTicker"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Exact maximum ticker value from the statement record. Use only for provider-specific filtering."""
+
+    max_ticker_any_of: Annotated[
+        Optional[str],
+        pydantic.Field(alias="maxTickerAnyOf"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Max ticker any-of filter. Return records matching at least one listed maxTicker value."""
+
+    max_ticker_after: Annotated[
+        Optional[str],
+        pydantic.Field(alias="maxTickerAfter"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Max ticker greater than (exclusive)"""
+
+    max_ticker_from: Annotated[
+        Optional[str],
+        pydantic.Field(alias="maxTickerFrom"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Max ticker greater than or equal (inclusive)"""
+
+    max_ticker_before: Annotated[
+        Optional[str],
+        pydantic.Field(alias="maxTickerBefore"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Max ticker upper-bound filter. Returns records before this value, excluding the value itself."""
+
+    max_ticker_to: Annotated[
+        Optional[str],
+        pydantic.Field(alias="maxTickerTo"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Max ticker less than or equal (inclusive)"""
+
+    min_ticker: Annotated[
+        Optional[str],
+        pydantic.Field(alias="minTicker"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Exact minimum ticker value from the statement record. Use only for provider-specific filtering."""
+
+    min_ticker_any_of: Annotated[
+        Optional[str],
+        pydantic.Field(alias="minTickerAnyOf"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Min ticker any-of filter. Return records matching at least one listed minTicker value."""
+
+    min_ticker_after: Annotated[
+        Optional[str],
+        pydantic.Field(alias="minTickerAfter"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Min ticker greater than (exclusive)"""
+
+    min_ticker_from: Annotated[
+        Optional[str],
+        pydantic.Field(alias="minTickerFrom"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Min ticker greater than or equal (inclusive)"""
+
+    min_ticker_before: Annotated[
+        Optional[str],
+        pydantic.Field(alias="minTickerBefore"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Min ticker upper-bound filter. Returns records before this value, excluding the value itself."""
+
+    min_ticker_to: Annotated[
+        Optional[str],
+        pydantic.Field(alias="minTickerTo"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Min ticker less than or equal (inclusive)"""
+
+    limit: Annotated[
+        Optional[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Maximum number of results per page. Use smaller values for UI pages and larger values for exports within API limits."""
+
+    sort: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""A comma-separated list of sort columns. For each column, append `.asc` or `.desc` to specify direction. Defaults to `period_end.asc` when not specified."""
+
+    next: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Pagination cursor from the previous response. Omit it on the first request, then send the returned cursor to fetch the next page."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "cik",
+                "ciks",
+                "cikAfter",
+                "cikFrom",
+                "cikBefore",
+                "cikTo",
+                "periodEnd",
+                "periodEndAfter",
+                "periodEndFrom",
+                "periodEndBefore",
+                "periodEndTo",
+                "filingDate",
+                "filingDateAfter",
+                "filingDateFrom",
+                "filingDateBefore",
+                "filingDateTo",
+                "tickers",
+                "tickersAllOf",
+                "tickersAnyOf",
+                "fiscalYear",
+                "fiscalYearAbove",
+                "fiscalYearMin",
+                "fiscalYearBelow",
+                "fiscalYearMax",
+                "fiscalQuarter",
+                "fiscalQuarterAbove",
+                "fiscalQuarterMin",
+                "fiscalQuarterBelow",
+                "fiscalQuarterMax",
+                "timeframe",
+                "timeframeAnyOf",
+                "timeframeAfter",
+                "timeframeFrom",
+                "timeframeBefore",
+                "timeframeTo",
+                "maxTicker",
+                "maxTickerAnyOf",
+                "maxTickerAfter",
+                "maxTickerFrom",
+                "maxTickerBefore",
+                "maxTickerTo",
+                "minTicker",
+                "minTickerAnyOf",
+                "minTickerAfter",
+                "minTickerFrom",
+                "minTickerBefore",
+                "minTickerTo",
+                "limit",
+                "sort",
+                "next",
+            ]
+        )
+        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 GetIncomeStatementsResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    income_statements_response: NotRequired[IncomeStatementsResponseTypedDict]
+    r"""Successful response with one or more SEC income statement rows, status, request id, and optional nextUrl for pagination."""
+
+
+class GetIncomeStatementsResponse(BaseModel):
+    next: Callable[[], Optional[GetIncomeStatementsResponse]]
+
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    income_statements_response: Optional[IncomeStatementsResponse] = None
+    r"""Successful response with one or more SEC income statement rows, status, request id, and optional nextUrl for pagination."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["IncomeStatementsResponse"])
+        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