finance_dev 0.9.0__py3-none-any.whl

finance_dev/filings.py

@@ -0,0 +1,586 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 17e0461c23a6
+
+from .basesdk import BaseSDK
+from datetime import date
+from finance_dev import errors, models, utils
+from finance_dev._hooks import HookContext
+from finance_dev.types import OptionalNullable, UNSET
+from finance_dev.utils.unmarshal_json_response import unmarshal_json_response
+from typing import Any, Mapping, Optional
+
+
+class Filings(BaseSDK):
+    def get_sec_filings(
+        self,
+        *,
+        symbol: Optional[str] = None,
+        cik: Optional[str] = None,
+        access_number: Optional[str] = None,
+        form: Optional[str] = None,
+        from_: Optional[date] = None,
+        to: Optional[date] = None,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.GetSecFilingsResponse:
+        r"""Get SEC Filings
+
+        Retrieve Securities and Exchange Commission (SEC) filings including 10-K annual reports, 10-Q quarterly reports, 8-K current reports, and proxy statements.
+
+        If set, this operation will use `client_id` from the global security.
+
+        :param symbol: Stock symbol (optional if cik provided)
+        :param cik: Central Index Key (optional if symbol provided)
+        :param access_number: SEC access number to filter by specific filing
+        :param form: Form type (e.g. 10-K, 10-Q, 8-K, DEF 14A)
+        :param from_: Start date in YYYY-MM-DD format. Enter the first date to include in the research window.
+        :param to: End date in YYYY-MM-DD format. Enter the last date to include in the research window.
+        :param retries: Override the default retry configuration for this method
+        :param server_url: Override the default server URL for this method
+        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if timeout_ms is None:
+            timeout_ms = 30000
+
+        if server_url is not None:
+            base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
+
+        request = models.GetSecFilingsRequest(
+            symbol=symbol,
+            cik=cik,
+            access_number=access_number,
+            form=form,
+            from_=from_,
+            to=to,
+        )
+
+        req = self._build_request(
+            method="GET",
+            path="/v1/filings/sec",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=False,
+            request_has_path_params=False,
+            request_has_query_params=True,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            security=self.sdk_configuration.security,
+            allow_empty_value=None,
+            allowed_fields=["client_id"],
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+            else:
+                retries = utils.RetryConfig(
+                    "backoff", utils.BackoffStrategy(500, 8000, 1.5, 60000), True
+                )
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = self.do_request(
+            hook_ctx=HookContext(
+                config=self.sdk_configuration,
+                base_url=base_url or "",
+                operation_id="getSecFilings",
+                oauth2_scopes=["market:supplemental"],
+                security_source=self.sdk_configuration.security,
+                tags=["Filings"],
+                extensions=None,
+            ),
+            request=req,
+            is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c),
+            retry_config=retry_config,
+        )
+
+        response_data: Any = None
+        if utils.match_response(http_res, "200", "application/json"):
+            return models.GetSecFilingsResponse(
+                sec_filings_response=unmarshal_json_response(
+                    Optional[models.SecFilingsResponse], http_res
+                ),
+                http_meta=models.HTTPMetadata(request=req, response=http_res),
+            )
+        if utils.match_response(http_res, "400", "application/json"):
+            response_data = unmarshal_json_response(errors.BadRequestUnion, http_res)
+            response_data.http_meta = models.HTTPMetadata(
+                request=req, response=http_res
+            )
+            raise errors.BadRequest(response_data, http_res)
+        if utils.match_response(http_res, "401", "application/json"):
+            response_data = unmarshal_json_response(errors.UnauthorizedUnion, http_res)
+            response_data.http_meta = models.HTTPMetadata(
+                request=req, response=http_res
+            )
+            raise errors.Unauthorized(response_data, http_res)
+        if utils.match_response(http_res, "403", "application/json"):
+            response_data = unmarshal_json_response(errors.ForbiddenUnion, http_res)
+            response_data.http_meta = models.HTTPMetadata(
+                request=req, response=http_res
+            )
+            raise errors.Forbidden(response_data, http_res)
+        if utils.match_response(http_res, "404", "application/json"):
+            response_data = unmarshal_json_response(errors.NotFoundUnion, http_res)
+            response_data.http_meta = models.HTTPMetadata(
+                request=req, response=http_res
+            )
+            raise errors.NotFound(response_data, http_res)
+        if utils.match_response(http_res, "500", "application/json"):
+            response_data = unmarshal_json_response(
+                errors.InternalServerErrorUnion, http_res
+            )
+            response_data.http_meta = models.HTTPMetadata(
+                request=req, response=http_res
+            )
+            raise errors.InternalServerError(response_data, http_res)
+        if utils.match_response(http_res, "4XX", "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+        if utils.match_response(http_res, "5XX", "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+
+        raise errors.APIError("Unexpected response received", http_res)
+
+    async def get_sec_filings_async(
+        self,
+        *,
+        symbol: Optional[str] = None,
+        cik: Optional[str] = None,
+        access_number: Optional[str] = None,
+        form: Optional[str] = None,
+        from_: Optional[date] = None,
+        to: Optional[date] = None,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.GetSecFilingsResponse:
+        r"""Get SEC Filings
+
+        Retrieve Securities and Exchange Commission (SEC) filings including 10-K annual reports, 10-Q quarterly reports, 8-K current reports, and proxy statements.
+
+        If set, this operation will use `client_id` from the global security.
+
+        :param symbol: Stock symbol (optional if cik provided)
+        :param cik: Central Index Key (optional if symbol provided)
+        :param access_number: SEC access number to filter by specific filing
+        :param form: Form type (e.g. 10-K, 10-Q, 8-K, DEF 14A)
+        :param from_: Start date in YYYY-MM-DD format. Enter the first date to include in the research window.
+        :param to: End date in YYYY-MM-DD format. Enter the last date to include in the research window.
+        :param retries: Override the default retry configuration for this method
+        :param server_url: Override the default server URL for this method
+        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if timeout_ms is None:
+            timeout_ms = 30000
+
+        if server_url is not None:
+            base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
+
+        request = models.GetSecFilingsRequest(
+            symbol=symbol,
+            cik=cik,
+            access_number=access_number,
+            form=form,
+            from_=from_,
+            to=to,
+        )
+
+        req = self._build_request_async(
+            method="GET",
+            path="/v1/filings/sec",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=False,
+            request_has_path_params=False,
+            request_has_query_params=True,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            security=self.sdk_configuration.security,
+            allow_empty_value=None,
+            allowed_fields=["client_id"],
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+            else:
+                retries = utils.RetryConfig(
+                    "backoff", utils.BackoffStrategy(500, 8000, 1.5, 60000), True
+                )
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = await self.do_request_async(
+            hook_ctx=HookContext(
+                config=self.sdk_configuration,
+                base_url=base_url or "",
+                operation_id="getSecFilings",
+                oauth2_scopes=["market:supplemental"],
+                security_source=self.sdk_configuration.security,
+                tags=["Filings"],
+                extensions=None,
+            ),
+            request=req,
+            is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c),
+            retry_config=retry_config,
+        )
+
+        response_data: Any = None
+        if utils.match_response(http_res, "200", "application/json"):
+            return models.GetSecFilingsResponse(
+                sec_filings_response=unmarshal_json_response(
+                    Optional[models.SecFilingsResponse], http_res
+                ),
+                http_meta=models.HTTPMetadata(request=req, response=http_res),
+            )
+        if utils.match_response(http_res, "400", "application/json"):
+            response_data = unmarshal_json_response(errors.BadRequestUnion, http_res)
+            response_data.http_meta = models.HTTPMetadata(
+                request=req, response=http_res
+            )
+            raise errors.BadRequest(response_data, http_res)
+        if utils.match_response(http_res, "401", "application/json"):
+            response_data = unmarshal_json_response(errors.UnauthorizedUnion, http_res)
+            response_data.http_meta = models.HTTPMetadata(
+                request=req, response=http_res
+            )
+            raise errors.Unauthorized(response_data, http_res)
+        if utils.match_response(http_res, "403", "application/json"):
+            response_data = unmarshal_json_response(errors.ForbiddenUnion, http_res)
+            response_data.http_meta = models.HTTPMetadata(
+                request=req, response=http_res
+            )
+            raise errors.Forbidden(response_data, http_res)
+        if utils.match_response(http_res, "404", "application/json"):
+            response_data = unmarshal_json_response(errors.NotFoundUnion, http_res)
+            response_data.http_meta = models.HTTPMetadata(
+                request=req, response=http_res
+            )
+            raise errors.NotFound(response_data, http_res)
+        if utils.match_response(http_res, "500", "application/json"):
+            response_data = unmarshal_json_response(
+                errors.InternalServerErrorUnion, http_res
+            )
+            response_data.http_meta = models.HTTPMetadata(
+                request=req, response=http_res
+            )
+            raise errors.InternalServerError(response_data, http_res)
+        if utils.match_response(http_res, "4XX", "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+        if utils.match_response(http_res, "5XX", "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+
+        raise errors.APIError("Unexpected response received", http_res)
+
+    def get_filings_similarity_index(
+        self,
+        *,
+        symbol: Optional[str] = None,
+        cik: Optional[str] = None,
+        freq: Optional[models.ReportingFrequency] = None,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.GetFilingsSimilarityIndexResponse:
+        r"""Get Filings Similarity Index
+
+        Retrieve similarity scores comparing current SEC filings to previous filings to identify significant changes in disclosures and risk factors. Provide either `symbol` or `cik`: `symbol` is required when `cik` is omitted, and `cik` is required when `symbol` is omitted. `freq` is optional.
+
+        At least one of symbol or cik is required; both are accepted.
+
+        If set, this operation will use `client_id` from the global security.
+
+        :param symbol: Stock symbol, such as AAPL. Use it to narrow results to one company. Required when `cik` is not provided.
+        :param cik: Central Index Key. Required when `symbol` is not provided.
+        :param freq: Reporting frequency filter. Use annual or quarterly when you want only one reporting cadence.
+        :param retries: Override the default retry configuration for this method
+        :param server_url: Override the default server URL for this method
+        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if timeout_ms is None:
+            timeout_ms = 30000
+
+        if server_url is not None:
+            base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
+
+        request = models.GetFilingsSimilarityIndexRequest(
+            symbol=symbol,
+            cik=cik,
+            freq=freq,
+        )
+
+        req = self._build_request(
+            method="GET",
+            path="/v1/filings/similarity-index",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=False,
+            request_has_path_params=False,
+            request_has_query_params=True,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            security=self.sdk_configuration.security,
+            allow_empty_value=None,
+            allowed_fields=["client_id"],
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+            else:
+                retries = utils.RetryConfig(
+                    "backoff", utils.BackoffStrategy(500, 8000, 1.5, 60000), True
+                )
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = self.do_request(
+            hook_ctx=HookContext(
+                config=self.sdk_configuration,
+                base_url=base_url or "",
+                operation_id="getFilingsSimilarityIndex",
+                oauth2_scopes=["market:supplemental"],
+                security_source=self.sdk_configuration.security,
+                tags=["Filings"],
+                extensions=None,
+            ),
+            request=req,
+            is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c),
+            retry_config=retry_config,
+        )
+
+        response_data: Any = None
+        if utils.match_response(http_res, "200", "application/json"):
+            return models.GetFilingsSimilarityIndexResponse(
+                filings_similarity_index_response=unmarshal_json_response(
+                    Optional[models.FilingsSimilarityIndexResponse], http_res
+                ),
+                http_meta=models.HTTPMetadata(request=req, response=http_res),
+            )
+        if utils.match_response(http_res, "400", "application/json"):
+            response_data = unmarshal_json_response(errors.BadRequestUnion, http_res)
+            response_data.http_meta = models.HTTPMetadata(
+                request=req, response=http_res
+            )
+            raise errors.BadRequest(response_data, http_res)
+        if utils.match_response(http_res, "401", "application/json"):
+            response_data = unmarshal_json_response(errors.UnauthorizedUnion, http_res)
+            response_data.http_meta = models.HTTPMetadata(
+                request=req, response=http_res
+            )
+            raise errors.Unauthorized(response_data, http_res)
+        if utils.match_response(http_res, "403", "application/json"):
+            response_data = unmarshal_json_response(errors.ForbiddenUnion, http_res)
+            response_data.http_meta = models.HTTPMetadata(
+                request=req, response=http_res
+            )
+            raise errors.Forbidden(response_data, http_res)
+        if utils.match_response(http_res, "404", "application/json"):
+            response_data = unmarshal_json_response(errors.NotFoundUnion, http_res)
+            response_data.http_meta = models.HTTPMetadata(
+                request=req, response=http_res
+            )
+            raise errors.NotFound(response_data, http_res)
+        if utils.match_response(http_res, "500", "application/json"):
+            response_data = unmarshal_json_response(
+                errors.InternalServerErrorUnion, http_res
+            )
+            response_data.http_meta = models.HTTPMetadata(
+                request=req, response=http_res
+            )
+            raise errors.InternalServerError(response_data, http_res)
+        if utils.match_response(http_res, "4XX", "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+        if utils.match_response(http_res, "5XX", "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+
+        raise errors.APIError("Unexpected response received", http_res)
+
+    async def get_filings_similarity_index_async(
+        self,
+        *,
+        symbol: Optional[str] = None,
+        cik: Optional[str] = None,
+        freq: Optional[models.ReportingFrequency] = None,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.GetFilingsSimilarityIndexResponse:
+        r"""Get Filings Similarity Index
+
+        Retrieve similarity scores comparing current SEC filings to previous filings to identify significant changes in disclosures and risk factors. Provide either `symbol` or `cik`: `symbol` is required when `cik` is omitted, and `cik` is required when `symbol` is omitted. `freq` is optional.
+
+        At least one of symbol or cik is required; both are accepted.
+
+        If set, this operation will use `client_id` from the global security.
+
+        :param symbol: Stock symbol, such as AAPL. Use it to narrow results to one company. Required when `cik` is not provided.
+        :param cik: Central Index Key. Required when `symbol` is not provided.
+        :param freq: Reporting frequency filter. Use annual or quarterly when you want only one reporting cadence.
+        :param retries: Override the default retry configuration for this method
+        :param server_url: Override the default server URL for this method
+        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if timeout_ms is None:
+            timeout_ms = 30000
+
+        if server_url is not None:
+            base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
+
+        request = models.GetFilingsSimilarityIndexRequest(
+            symbol=symbol,
+            cik=cik,
+            freq=freq,
+        )
+
+        req = self._build_request_async(
+            method="GET",
+            path="/v1/filings/similarity-index",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=False,
+            request_has_path_params=False,
+            request_has_query_params=True,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            security=self.sdk_configuration.security,
+            allow_empty_value=None,
+            allowed_fields=["client_id"],
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+            else:
+                retries = utils.RetryConfig(
+                    "backoff", utils.BackoffStrategy(500, 8000, 1.5, 60000), True
+                )
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = await self.do_request_async(
+            hook_ctx=HookContext(
+                config=self.sdk_configuration,
+                base_url=base_url or "",
+                operation_id="getFilingsSimilarityIndex",
+                oauth2_scopes=["market:supplemental"],
+                security_source=self.sdk_configuration.security,
+                tags=["Filings"],
+                extensions=None,
+            ),
+            request=req,
+            is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c),
+            retry_config=retry_config,
+        )
+
+        response_data: Any = None
+        if utils.match_response(http_res, "200", "application/json"):
+            return models.GetFilingsSimilarityIndexResponse(
+                filings_similarity_index_response=unmarshal_json_response(
+                    Optional[models.FilingsSimilarityIndexResponse], http_res
+                ),
+                http_meta=models.HTTPMetadata(request=req, response=http_res),
+            )
+        if utils.match_response(http_res, "400", "application/json"):
+            response_data = unmarshal_json_response(errors.BadRequestUnion, http_res)
+            response_data.http_meta = models.HTTPMetadata(
+                request=req, response=http_res
+            )
+            raise errors.BadRequest(response_data, http_res)
+        if utils.match_response(http_res, "401", "application/json"):
+            response_data = unmarshal_json_response(errors.UnauthorizedUnion, http_res)
+            response_data.http_meta = models.HTTPMetadata(
+                request=req, response=http_res
+            )
+            raise errors.Unauthorized(response_data, http_res)
+        if utils.match_response(http_res, "403", "application/json"):
+            response_data = unmarshal_json_response(errors.ForbiddenUnion, http_res)
+            response_data.http_meta = models.HTTPMetadata(
+                request=req, response=http_res
+            )
+            raise errors.Forbidden(response_data, http_res)
+        if utils.match_response(http_res, "404", "application/json"):
+            response_data = unmarshal_json_response(errors.NotFoundUnion, http_res)
+            response_data.http_meta = models.HTTPMetadata(
+                request=req, response=http_res
+            )
+            raise errors.NotFound(response_data, http_res)
+        if utils.match_response(http_res, "500", "application/json"):
+            response_data = unmarshal_json_response(
+                errors.InternalServerErrorUnion, http_res
+            )
+            response_data.http_meta = models.HTTPMetadata(
+                request=req, response=http_res
+            )
+            raise errors.InternalServerError(response_data, http_res)
+        if utils.match_response(http_res, "4XX", "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+        if utils.match_response(http_res, "5XX", "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+
+        raise errors.APIError("Unexpected response received", http_res)