invinite-data-api 0.1.0__py3-none-any.whl

invinite_data_api/api/as_reported_balance_sheet_api.py

@@ -0,0 +1,1086 @@
+"""
+    Invinite API
+
+    Invinite financial data API. Each endpoint has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Included-Remaining` what is left of the plan's included credits. `GET /v1/account/usage` returns your account's usage by day, endpoint family and key (it costs no credits). SEC filing search has a 100-credit base cost.  ## Webhooks  Accounts on LITE and above subscribe with `POST /v1/earnings-calls/webhooks` to the `earnings_call.*` lifecycle events (filtered by CIK); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan's limit; `ping` needs no subscription — the test route and the disabled notice send it to any subscription):  | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) |  Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `ping` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`.  ## Licensing  | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – |  Invinite data may be shown and, from PRO, redistributed inside the licensee's own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee's own data, at any tier, under any contract.  Policy version: 2026-10-draft. Draft — pending counsel sign-off.  Audio files are forensically watermarked per customer. Audio is served through signed URLs, is subject to per-company takedown and may not be re-hosted; every delivered file carries a per-account forensic watermark: a copy found elsewhere is traced to the account that received it.  SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite's.  Every `/v1/*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/account/usage` serves no licensed data and carries none.  ## Status  [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API.  Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours.  Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, WebSocket, Account.
+
+    The version of the OpenAPI document: 1.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import warnings
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+
+from pydantic import Field, StrictStr, field_validator
+from typing import Optional
+from typing_extensions import Annotated
+from invinite_data_api.models.as_reported_income_statement200_response import AsReportedIncomeStatement200Response
+from invinite_data_api.models.as_reported_income_statement_detailed200_response import AsReportedIncomeStatementDetailed200Response
+from invinite_data_api.models.as_reported_income_statement_presentation200_response import AsReportedIncomeStatementPresentation200Response
+
+from invinite_data_api.api_client import ApiClient, RequestSerialized
+from invinite_data_api.api_response import ApiResponse
+from invinite_data_api.rest import RESTResponseType
+
+
+class AsReportedBalanceSheetApi:
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    def __init__(self, api_client=None) -> None:
+        if api_client is None:
+            api_client = ApiClient.get_default()
+        self.api_client = api_client
+
+
+    @validate_call
+    def as_reported_balance_sheet(
+        self,
+        identifier: Annotated[StrictStr, Field(description="Ticker symbol or CIK")],
+        fiscal_period_type: Annotated[StrictStr, Field(description="Type of fiscal period")],
+        sort: Annotated[Optional[StrictStr], Field(description="Sort direction for periods by period_end")] = None,
+        limit: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Maximum number of periods per ticker")] = None,
+        offset: Annotated[Optional[Annotated[int, Field(strict=True, ge=0)]], Field(description="Number of periods to skip for pagination")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> AsReportedIncomeStatement200Response:
+        """As-reported balance sheet
+
+        Fetch as-reported balance sheet data for a company. Minimum tier for redistribute: PRO.
+
+        :param identifier: Ticker symbol or CIK (required)
+        :type identifier: str
+        :param fiscal_period_type: Type of fiscal period (required)
+        :type fiscal_period_type: str
+        :param sort: Sort direction for periods by period_end
+        :type sort: str
+        :param limit: Maximum number of periods per ticker
+        :type limit: int
+        :param offset: Number of periods to skip for pagination
+        :type offset: int
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._as_reported_balance_sheet_serialize(
+            identifier=identifier,
+            fiscal_period_type=fiscal_period_type,
+            sort=sort,
+            limit=limit,
+            offset=offset,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "AsReportedIncomeStatement200Response",
+            '400': "CompanyAvailableCompanies401Response",
+            '401': "CompanyAvailableCompanies401Response",
+            '404': "CompanyAvailableCompanies401Response",
+            '500': "CompanyAvailableCompanies401Response",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def as_reported_balance_sheet_with_http_info(
+        self,
+        identifier: Annotated[StrictStr, Field(description="Ticker symbol or CIK")],
+        fiscal_period_type: Annotated[StrictStr, Field(description="Type of fiscal period")],
+        sort: Annotated[Optional[StrictStr], Field(description="Sort direction for periods by period_end")] = None,
+        limit: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Maximum number of periods per ticker")] = None,
+        offset: Annotated[Optional[Annotated[int, Field(strict=True, ge=0)]], Field(description="Number of periods to skip for pagination")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[AsReportedIncomeStatement200Response]:
+        """As-reported balance sheet
+
+        Fetch as-reported balance sheet data for a company. Minimum tier for redistribute: PRO.
+
+        :param identifier: Ticker symbol or CIK (required)
+        :type identifier: str
+        :param fiscal_period_type: Type of fiscal period (required)
+        :type fiscal_period_type: str
+        :param sort: Sort direction for periods by period_end
+        :type sort: str
+        :param limit: Maximum number of periods per ticker
+        :type limit: int
+        :param offset: Number of periods to skip for pagination
+        :type offset: int
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._as_reported_balance_sheet_serialize(
+            identifier=identifier,
+            fiscal_period_type=fiscal_period_type,
+            sort=sort,
+            limit=limit,
+            offset=offset,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "AsReportedIncomeStatement200Response",
+            '400': "CompanyAvailableCompanies401Response",
+            '401': "CompanyAvailableCompanies401Response",
+            '404': "CompanyAvailableCompanies401Response",
+            '500': "CompanyAvailableCompanies401Response",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def as_reported_balance_sheet_without_preload_content(
+        self,
+        identifier: Annotated[StrictStr, Field(description="Ticker symbol or CIK")],
+        fiscal_period_type: Annotated[StrictStr, Field(description="Type of fiscal period")],
+        sort: Annotated[Optional[StrictStr], Field(description="Sort direction for periods by period_end")] = None,
+        limit: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Maximum number of periods per ticker")] = None,
+        offset: Annotated[Optional[Annotated[int, Field(strict=True, ge=0)]], Field(description="Number of periods to skip for pagination")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """As-reported balance sheet
+
+        Fetch as-reported balance sheet data for a company. Minimum tier for redistribute: PRO.
+
+        :param identifier: Ticker symbol or CIK (required)
+        :type identifier: str
+        :param fiscal_period_type: Type of fiscal period (required)
+        :type fiscal_period_type: str
+        :param sort: Sort direction for periods by period_end
+        :type sort: str
+        :param limit: Maximum number of periods per ticker
+        :type limit: int
+        :param offset: Number of periods to skip for pagination
+        :type offset: int
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._as_reported_balance_sheet_serialize(
+            identifier=identifier,
+            fiscal_period_type=fiscal_period_type,
+            sort=sort,
+            limit=limit,
+            offset=offset,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "AsReportedIncomeStatement200Response",
+            '400': "CompanyAvailableCompanies401Response",
+            '401': "CompanyAvailableCompanies401Response",
+            '404': "CompanyAvailableCompanies401Response",
+            '500': "CompanyAvailableCompanies401Response",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _as_reported_balance_sheet_serialize(
+        self,
+        identifier,
+        fiscal_period_type,
+        sort,
+        limit,
+        offset,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        if identifier is not None:
+            
+            _query_params.append(('identifier', identifier))
+            
+        if fiscal_period_type is not None:
+            
+            _query_params.append(('fiscal_period_type', fiscal_period_type))
+            
+        if sort is not None:
+            
+            _query_params.append(('sort', sort))
+            
+        if limit is not None:
+            
+            _query_params.append(('limit', limit))
+            
+        if offset is not None:
+            
+            _query_params.append(('offset', offset))
+            
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json'
+                ]
+            )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'bearerAuth'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/v1/as-reported/balance-sheet',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
+    @validate_call
+    def as_reported_balance_sheet_detailed(
+        self,
+        identifier: Annotated[StrictStr, Field(description="Ticker symbol or CIK")],
+        fiscal_period_type: Annotated[StrictStr, Field(description="Type of fiscal period")],
+        sort: Annotated[Optional[StrictStr], Field(description="Sort direction for periods by period_end")] = None,
+        limit: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Maximum number of periods per ticker")] = None,
+        offset: Annotated[Optional[Annotated[int, Field(strict=True, ge=0)]], Field(description="Number of periods to skip for pagination")] = None,
+        with_formula: Annotated[Optional[StrictStr], Field(description="Include formula in response")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> AsReportedIncomeStatementDetailed200Response:
+        """As-reported balance sheet (detailed)
+
+        Fetch detailed as-reported balance sheet data with html_label, formula, accession number, and html tag info. Minimum tier for redistribute: PRO.
+
+        :param identifier: Ticker symbol or CIK (required)
+        :type identifier: str
+        :param fiscal_period_type: Type of fiscal period (required)
+        :type fiscal_period_type: str
+        :param sort: Sort direction for periods by period_end
+        :type sort: str
+        :param limit: Maximum number of periods per ticker
+        :type limit: int
+        :param offset: Number of periods to skip for pagination
+        :type offset: int
+        :param with_formula: Include formula in response
+        :type with_formula: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._as_reported_balance_sheet_detailed_serialize(
+            identifier=identifier,
+            fiscal_period_type=fiscal_period_type,
+            sort=sort,
+            limit=limit,
+            offset=offset,
+            with_formula=with_formula,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "AsReportedIncomeStatementDetailed200Response",
+            '400': "CompanyAvailableCompanies401Response",
+            '401': "CompanyAvailableCompanies401Response",
+            '404': "CompanyAvailableCompanies401Response",
+            '500': "CompanyAvailableCompanies401Response",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def as_reported_balance_sheet_detailed_with_http_info(
+        self,
+        identifier: Annotated[StrictStr, Field(description="Ticker symbol or CIK")],
+        fiscal_period_type: Annotated[StrictStr, Field(description="Type of fiscal period")],
+        sort: Annotated[Optional[StrictStr], Field(description="Sort direction for periods by period_end")] = None,
+        limit: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Maximum number of periods per ticker")] = None,
+        offset: Annotated[Optional[Annotated[int, Field(strict=True, ge=0)]], Field(description="Number of periods to skip for pagination")] = None,
+        with_formula: Annotated[Optional[StrictStr], Field(description="Include formula in response")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[AsReportedIncomeStatementDetailed200Response]:
+        """As-reported balance sheet (detailed)
+
+        Fetch detailed as-reported balance sheet data with html_label, formula, accession number, and html tag info. Minimum tier for redistribute: PRO.
+
+        :param identifier: Ticker symbol or CIK (required)
+        :type identifier: str
+        :param fiscal_period_type: Type of fiscal period (required)
+        :type fiscal_period_type: str
+        :param sort: Sort direction for periods by period_end
+        :type sort: str
+        :param limit: Maximum number of periods per ticker
+        :type limit: int
+        :param offset: Number of periods to skip for pagination
+        :type offset: int
+        :param with_formula: Include formula in response
+        :type with_formula: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._as_reported_balance_sheet_detailed_serialize(
+            identifier=identifier,
+            fiscal_period_type=fiscal_period_type,
+            sort=sort,
+            limit=limit,
+            offset=offset,
+            with_formula=with_formula,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "AsReportedIncomeStatementDetailed200Response",
+            '400': "CompanyAvailableCompanies401Response",
+            '401': "CompanyAvailableCompanies401Response",
+            '404': "CompanyAvailableCompanies401Response",
+            '500': "CompanyAvailableCompanies401Response",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def as_reported_balance_sheet_detailed_without_preload_content(
+        self,
+        identifier: Annotated[StrictStr, Field(description="Ticker symbol or CIK")],
+        fiscal_period_type: Annotated[StrictStr, Field(description="Type of fiscal period")],
+        sort: Annotated[Optional[StrictStr], Field(description="Sort direction for periods by period_end")] = None,
+        limit: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Maximum number of periods per ticker")] = None,
+        offset: Annotated[Optional[Annotated[int, Field(strict=True, ge=0)]], Field(description="Number of periods to skip for pagination")] = None,
+        with_formula: Annotated[Optional[StrictStr], Field(description="Include formula in response")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """As-reported balance sheet (detailed)
+
+        Fetch detailed as-reported balance sheet data with html_label, formula, accession number, and html tag info. Minimum tier for redistribute: PRO.
+
+        :param identifier: Ticker symbol or CIK (required)
+        :type identifier: str
+        :param fiscal_period_type: Type of fiscal period (required)
+        :type fiscal_period_type: str
+        :param sort: Sort direction for periods by period_end
+        :type sort: str
+        :param limit: Maximum number of periods per ticker
+        :type limit: int
+        :param offset: Number of periods to skip for pagination
+        :type offset: int
+        :param with_formula: Include formula in response
+        :type with_formula: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._as_reported_balance_sheet_detailed_serialize(
+            identifier=identifier,
+            fiscal_period_type=fiscal_period_type,
+            sort=sort,
+            limit=limit,
+            offset=offset,
+            with_formula=with_formula,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "AsReportedIncomeStatementDetailed200Response",
+            '400': "CompanyAvailableCompanies401Response",
+            '401': "CompanyAvailableCompanies401Response",
+            '404': "CompanyAvailableCompanies401Response",
+            '500': "CompanyAvailableCompanies401Response",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _as_reported_balance_sheet_detailed_serialize(
+        self,
+        identifier,
+        fiscal_period_type,
+        sort,
+        limit,
+        offset,
+        with_formula,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        if identifier is not None:
+            
+            _query_params.append(('identifier', identifier))
+            
+        if fiscal_period_type is not None:
+            
+            _query_params.append(('fiscal_period_type', fiscal_period_type))
+            
+        if sort is not None:
+            
+            _query_params.append(('sort', sort))
+            
+        if limit is not None:
+            
+            _query_params.append(('limit', limit))
+            
+        if offset is not None:
+            
+            _query_params.append(('offset', offset))
+            
+        if with_formula is not None:
+            
+            _query_params.append(('with_formula', with_formula))
+            
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json'
+                ]
+            )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'bearerAuth'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/v1/as-reported/balance-sheet/detailed',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
+    @validate_call
+    def as_reported_balance_sheet_presentation(
+        self,
+        identifier: Annotated[StrictStr, Field(description="Ticker symbol or CIK")],
+        fiscal_period_type: Annotated[StrictStr, Field(description="Type of fiscal period")],
+        sort: Annotated[Optional[StrictStr], Field(description="Sort direction for periods by period_end")] = None,
+        limit: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Maximum number of periods per ticker")] = None,
+        offset: Annotated[Optional[Annotated[int, Field(strict=True, ge=0)]], Field(description="Number of periods to skip for pagination")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> AsReportedIncomeStatementPresentation200Response:
+        """As-reported balance sheet (presentation)
+
+        Fetch as-reported balance sheet data in presentation format (nested tree structure based on parent_path). Minimum tier for redistribute: PRO.
+
+        :param identifier: Ticker symbol or CIK (required)
+        :type identifier: str
+        :param fiscal_period_type: Type of fiscal period (required)
+        :type fiscal_period_type: str
+        :param sort: Sort direction for periods by period_end
+        :type sort: str
+        :param limit: Maximum number of periods per ticker
+        :type limit: int
+        :param offset: Number of periods to skip for pagination
+        :type offset: int
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._as_reported_balance_sheet_presentation_serialize(
+            identifier=identifier,
+            fiscal_period_type=fiscal_period_type,
+            sort=sort,
+            limit=limit,
+            offset=offset,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "AsReportedIncomeStatementPresentation200Response",
+            '400': "CompanyAvailableCompanies401Response",
+            '401': "CompanyAvailableCompanies401Response",
+            '404': "CompanyAvailableCompanies401Response",
+            '500': "CompanyAvailableCompanies401Response",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def as_reported_balance_sheet_presentation_with_http_info(
+        self,
+        identifier: Annotated[StrictStr, Field(description="Ticker symbol or CIK")],
+        fiscal_period_type: Annotated[StrictStr, Field(description="Type of fiscal period")],
+        sort: Annotated[Optional[StrictStr], Field(description="Sort direction for periods by period_end")] = None,
+        limit: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Maximum number of periods per ticker")] = None,
+        offset: Annotated[Optional[Annotated[int, Field(strict=True, ge=0)]], Field(description="Number of periods to skip for pagination")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[AsReportedIncomeStatementPresentation200Response]:
+        """As-reported balance sheet (presentation)
+
+        Fetch as-reported balance sheet data in presentation format (nested tree structure based on parent_path). Minimum tier for redistribute: PRO.
+
+        :param identifier: Ticker symbol or CIK (required)
+        :type identifier: str
+        :param fiscal_period_type: Type of fiscal period (required)
+        :type fiscal_period_type: str
+        :param sort: Sort direction for periods by period_end
+        :type sort: str
+        :param limit: Maximum number of periods per ticker
+        :type limit: int
+        :param offset: Number of periods to skip for pagination
+        :type offset: int
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._as_reported_balance_sheet_presentation_serialize(
+            identifier=identifier,
+            fiscal_period_type=fiscal_period_type,
+            sort=sort,
+            limit=limit,
+            offset=offset,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "AsReportedIncomeStatementPresentation200Response",
+            '400': "CompanyAvailableCompanies401Response",
+            '401': "CompanyAvailableCompanies401Response",
+            '404': "CompanyAvailableCompanies401Response",
+            '500': "CompanyAvailableCompanies401Response",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def as_reported_balance_sheet_presentation_without_preload_content(
+        self,
+        identifier: Annotated[StrictStr, Field(description="Ticker symbol or CIK")],
+        fiscal_period_type: Annotated[StrictStr, Field(description="Type of fiscal period")],
+        sort: Annotated[Optional[StrictStr], Field(description="Sort direction for periods by period_end")] = None,
+        limit: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Maximum number of periods per ticker")] = None,
+        offset: Annotated[Optional[Annotated[int, Field(strict=True, ge=0)]], Field(description="Number of periods to skip for pagination")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """As-reported balance sheet (presentation)
+
+        Fetch as-reported balance sheet data in presentation format (nested tree structure based on parent_path). Minimum tier for redistribute: PRO.
+
+        :param identifier: Ticker symbol or CIK (required)
+        :type identifier: str
+        :param fiscal_period_type: Type of fiscal period (required)
+        :type fiscal_period_type: str
+        :param sort: Sort direction for periods by period_end
+        :type sort: str
+        :param limit: Maximum number of periods per ticker
+        :type limit: int
+        :param offset: Number of periods to skip for pagination
+        :type offset: int
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._as_reported_balance_sheet_presentation_serialize(
+            identifier=identifier,
+            fiscal_period_type=fiscal_period_type,
+            sort=sort,
+            limit=limit,
+            offset=offset,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "AsReportedIncomeStatementPresentation200Response",
+            '400': "CompanyAvailableCompanies401Response",
+            '401': "CompanyAvailableCompanies401Response",
+            '404': "CompanyAvailableCompanies401Response",
+            '500': "CompanyAvailableCompanies401Response",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _as_reported_balance_sheet_presentation_serialize(
+        self,
+        identifier,
+        fiscal_period_type,
+        sort,
+        limit,
+        offset,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        if identifier is not None:
+            
+            _query_params.append(('identifier', identifier))
+            
+        if fiscal_period_type is not None:
+            
+            _query_params.append(('fiscal_period_type', fiscal_period_type))
+            
+        if sort is not None:
+            
+            _query_params.append(('sort', sort))
+            
+        if limit is not None:
+            
+            _query_params.append(('limit', limit))
+            
+        if offset is not None:
+            
+            _query_params.append(('offset', offset))
+            
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json'
+                ]
+            )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'bearerAuth'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/v1/as-reported/balance-sheet/presentation',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+