invinite-data-api 2.0.0__tar.gz → 3.0.0__tar.gz

{invinite_data_api-2.0.0 → invinite_data_api-3.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: invinite_data_api
-Version: 2.0.0
+Version: 3.0.0
 Summary: Typed Python client for the Invinite Data API
 Home-page: 
 Author: OpenAPI Generator community

{invinite_data_api-2.0.0 → invinite_data_api-3.0.0}/invinite_data_api/__init__.py

@@ -14,7 +14,7 @@
 """  # noqa: E501
 
 
-__version__ = "2.0.0"
+__version__ = "3.0.0"
 
 # Define package exports
 __all__ = [
@@ -55,16 +55,21 @@ __all__ = [
     "AccountUsage200ResponseDailyInner",
     "AccountUsage200ResponseDailyInnerErrors",
     "AccountUsage200ResponsePeriod",
+    "AsReportedDetailedFact",
+    "AsReportedFact",
     "AsReportedIncomeStatement200Response",
     "AsReportedIncomeStatement200ResponseCompaniesInner",
     "AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInner",
     "AsReportedIncomeStatementDetailed200Response",
     "AsReportedIncomeStatementDetailed200ResponseCompaniesInner",
     "AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInner",
-    "AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue",
     "AsReportedIncomeStatementPresentation200Response",
     "AsReportedIncomeStatementPresentation200ResponseCompaniesInner",
     "AsReportedIncomeStatementPresentation200ResponseCompaniesInnerPeriodsInner",
+    "AsReportedSnapshot200Response",
+    "AsReportedSnapshot200ResponseCompaniesInner",
+    "AsReportedSnapshot200ResponseCompaniesInnerStatements",
+    "AsReportedSnapshot200ResponseCompaniesInnerStatementsIncomeStatement",
     "AsReportedSnapshotDetailed200Response",
     "AsReportedSnapshotDetailed200ResponseCompaniesInner",
     "AsReportedSnapshotDetailed200ResponseCompaniesInnerStatements",
@@ -386,16 +391,21 @@ from invinite_data_api.models.account_usage200_response_by_key_inner import Acco
 from invinite_data_api.models.account_usage200_response_daily_inner import AccountUsage200ResponseDailyInner as AccountUsage200ResponseDailyInner
 from invinite_data_api.models.account_usage200_response_daily_inner_errors import AccountUsage200ResponseDailyInnerErrors as AccountUsage200ResponseDailyInnerErrors
 from invinite_data_api.models.account_usage200_response_period import AccountUsage200ResponsePeriod as AccountUsage200ResponsePeriod
+from invinite_data_api.models.as_reported_detailed_fact import AsReportedDetailedFact as AsReportedDetailedFact
+from invinite_data_api.models.as_reported_fact import AsReportedFact as AsReportedFact
 from invinite_data_api.models.as_reported_income_statement200_response import AsReportedIncomeStatement200Response as AsReportedIncomeStatement200Response
 from invinite_data_api.models.as_reported_income_statement200_response_companies_inner import AsReportedIncomeStatement200ResponseCompaniesInner as AsReportedIncomeStatement200ResponseCompaniesInner
 from invinite_data_api.models.as_reported_income_statement200_response_companies_inner_periods_inner import AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInner as AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInner
 from invinite_data_api.models.as_reported_income_statement_detailed200_response import AsReportedIncomeStatementDetailed200Response as AsReportedIncomeStatementDetailed200Response
 from invinite_data_api.models.as_reported_income_statement_detailed200_response_companies_inner import AsReportedIncomeStatementDetailed200ResponseCompaniesInner as AsReportedIncomeStatementDetailed200ResponseCompaniesInner
 from invinite_data_api.models.as_reported_income_statement_detailed200_response_companies_inner_periods_inner import AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInner as AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInner
-from invinite_data_api.models.as_reported_income_statement_detailed200_response_companies_inner_periods_inner_facts_value import AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue as AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue
 from invinite_data_api.models.as_reported_income_statement_presentation200_response import AsReportedIncomeStatementPresentation200Response as AsReportedIncomeStatementPresentation200Response
 from invinite_data_api.models.as_reported_income_statement_presentation200_response_companies_inner import AsReportedIncomeStatementPresentation200ResponseCompaniesInner as AsReportedIncomeStatementPresentation200ResponseCompaniesInner
 from invinite_data_api.models.as_reported_income_statement_presentation200_response_companies_inner_periods_inner import AsReportedIncomeStatementPresentation200ResponseCompaniesInnerPeriodsInner as AsReportedIncomeStatementPresentation200ResponseCompaniesInnerPeriodsInner
+from invinite_data_api.models.as_reported_snapshot200_response import AsReportedSnapshot200Response as AsReportedSnapshot200Response
+from invinite_data_api.models.as_reported_snapshot200_response_companies_inner import AsReportedSnapshot200ResponseCompaniesInner as AsReportedSnapshot200ResponseCompaniesInner
+from invinite_data_api.models.as_reported_snapshot200_response_companies_inner_statements import AsReportedSnapshot200ResponseCompaniesInnerStatements as AsReportedSnapshot200ResponseCompaniesInnerStatements
+from invinite_data_api.models.as_reported_snapshot200_response_companies_inner_statements_income_statement import AsReportedSnapshot200ResponseCompaniesInnerStatementsIncomeStatement as AsReportedSnapshot200ResponseCompaniesInnerStatementsIncomeStatement
 from invinite_data_api.models.as_reported_snapshot_detailed200_response import AsReportedSnapshotDetailed200Response as AsReportedSnapshotDetailed200Response
 from invinite_data_api.models.as_reported_snapshot_detailed200_response_companies_inner import AsReportedSnapshotDetailed200ResponseCompaniesInner as AsReportedSnapshotDetailed200ResponseCompaniesInner
 from invinite_data_api.models.as_reported_snapshot_detailed200_response_companies_inner_statements import AsReportedSnapshotDetailed200ResponseCompaniesInnerStatements as AsReportedSnapshotDetailed200ResponseCompaniesInnerStatements

{invinite_data_api-2.0.0 → invinite_data_api-3.0.0}/invinite_data_api/api/as_reported_balance_sheet_api.py

@@ -48,6 +48,7 @@ class AsReportedBalanceSheetApi:
         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,
+        reported_only: Annotated[Optional[StrictStr], Field(description="`true`: only the facts the company reported (`derived: false`); the pipeline's derived Q4 / TTM / YTD values are left out")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -75,6 +76,8 @@ class AsReportedBalanceSheetApi:
         :type limit: int
         :param offset: Number of periods to skip for pagination
         :type offset: int
+        :param reported_only: `true`: only the facts the company reported (`derived: false`); the pipeline's derived Q4 / TTM / YTD values are left out
+        :type reported_only: 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
@@ -103,6 +106,7 @@ class AsReportedBalanceSheetApi:
             sort=sort,
             limit=limit,
             offset=offset,
+            reported_only=reported_only,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -135,6 +139,7 @@ class AsReportedBalanceSheetApi:
         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,
+        reported_only: Annotated[Optional[StrictStr], Field(description="`true`: only the facts the company reported (`derived: false`); the pipeline's derived Q4 / TTM / YTD values are left out")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -162,6 +167,8 @@ class AsReportedBalanceSheetApi:
         :type limit: int
         :param offset: Number of periods to skip for pagination
         :type offset: int
+        :param reported_only: `true`: only the facts the company reported (`derived: false`); the pipeline's derived Q4 / TTM / YTD values are left out
+        :type reported_only: 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
@@ -190,6 +197,7 @@ class AsReportedBalanceSheetApi:
             sort=sort,
             limit=limit,
             offset=offset,
+            reported_only=reported_only,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -222,6 +230,7 @@ class AsReportedBalanceSheetApi:
         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,
+        reported_only: Annotated[Optional[StrictStr], Field(description="`true`: only the facts the company reported (`derived: false`); the pipeline's derived Q4 / TTM / YTD values are left out")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -249,6 +258,8 @@ class AsReportedBalanceSheetApi:
         :type limit: int
         :param offset: Number of periods to skip for pagination
         :type offset: int
+        :param reported_only: `true`: only the facts the company reported (`derived: false`); the pipeline's derived Q4 / TTM / YTD values are left out
+        :type reported_only: 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
@@ -277,6 +288,7 @@ class AsReportedBalanceSheetApi:
             sort=sort,
             limit=limit,
             offset=offset,
+            reported_only=reported_only,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -304,6 +316,7 @@ class AsReportedBalanceSheetApi:
         sort,
         limit,
         offset,
+        reported_only,
         _request_auth,
         _content_type,
         _headers,
@@ -346,6 +359,10 @@ class AsReportedBalanceSheetApi:
             
             _query_params.append(('offset', offset))
             
+        if reported_only is not None:
+            
+            _query_params.append(('reported_only', reported_only))
+            
         # process the header parameters
         # process the form parameters
         # process the body parameter
@@ -391,7 +408,8 @@ class AsReportedBalanceSheetApi:
         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,
+        with_formula: Annotated[Optional[StrictStr], Field(description="Include each derived fact's formula (its members and their values)")] = None,
+        reported_only: Annotated[Optional[StrictStr], Field(description="`true`: only the facts the company reported (`derived: false`); the pipeline's derived Q4 / TTM / YTD values are left out")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -407,7 +425,7 @@ class AsReportedBalanceSheetApi:
     ) -> 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.
+        Fetch detailed as-reported balance sheet data with derived flag, taxonomy and company labels, decimals, accession number, html tag id and optional formula. Minimum tier for redistribute: PRO.
 
         :param identifier: Ticker symbol or CIK. Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. (required)
         :type identifier: str
@@ -419,8 +437,10 @@ class AsReportedBalanceSheetApi:
         :type limit: int
         :param offset: Number of periods to skip for pagination
         :type offset: int
-        :param with_formula: Include formula in response
+        :param with_formula: Include each derived fact's formula (its members and their values)
         :type with_formula: str
+        :param reported_only: `true`: only the facts the company reported (`derived: false`); the pipeline's derived Q4 / TTM / YTD values are left out
+        :type reported_only: 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
@@ -450,6 +470,7 @@ class AsReportedBalanceSheetApi:
             limit=limit,
             offset=offset,
             with_formula=with_formula,
+            reported_only=reported_only,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -482,7 +503,8 @@ class AsReportedBalanceSheetApi:
         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,
+        with_formula: Annotated[Optional[StrictStr], Field(description="Include each derived fact's formula (its members and their values)")] = None,
+        reported_only: Annotated[Optional[StrictStr], Field(description="`true`: only the facts the company reported (`derived: false`); the pipeline's derived Q4 / TTM / YTD values are left out")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -498,7 +520,7 @@ class AsReportedBalanceSheetApi:
     ) -> 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.
+        Fetch detailed as-reported balance sheet data with derived flag, taxonomy and company labels, decimals, accession number, html tag id and optional formula. Minimum tier for redistribute: PRO.
 
         :param identifier: Ticker symbol or CIK. Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. (required)
         :type identifier: str
@@ -510,8 +532,10 @@ class AsReportedBalanceSheetApi:
         :type limit: int
         :param offset: Number of periods to skip for pagination
         :type offset: int
-        :param with_formula: Include formula in response
+        :param with_formula: Include each derived fact's formula (its members and their values)
         :type with_formula: str
+        :param reported_only: `true`: only the facts the company reported (`derived: false`); the pipeline's derived Q4 / TTM / YTD values are left out
+        :type reported_only: 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
@@ -541,6 +565,7 @@ class AsReportedBalanceSheetApi:
             limit=limit,
             offset=offset,
             with_formula=with_formula,
+            reported_only=reported_only,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -573,7 +598,8 @@ class AsReportedBalanceSheetApi:
         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,
+        with_formula: Annotated[Optional[StrictStr], Field(description="Include each derived fact's formula (its members and their values)")] = None,
+        reported_only: Annotated[Optional[StrictStr], Field(description="`true`: only the facts the company reported (`derived: false`); the pipeline's derived Q4 / TTM / YTD values are left out")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -589,7 +615,7 @@ class AsReportedBalanceSheetApi:
     ) -> 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.
+        Fetch detailed as-reported balance sheet data with derived flag, taxonomy and company labels, decimals, accession number, html tag id and optional formula. Minimum tier for redistribute: PRO.
 
         :param identifier: Ticker symbol or CIK. Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. (required)
         :type identifier: str
@@ -601,8 +627,10 @@ class AsReportedBalanceSheetApi:
         :type limit: int
         :param offset: Number of periods to skip for pagination
         :type offset: int
-        :param with_formula: Include formula in response
+        :param with_formula: Include each derived fact's formula (its members and their values)
         :type with_formula: str
+        :param reported_only: `true`: only the facts the company reported (`derived: false`); the pipeline's derived Q4 / TTM / YTD values are left out
+        :type reported_only: 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
@@ -632,6 +660,7 @@ class AsReportedBalanceSheetApi:
             limit=limit,
             offset=offset,
             with_formula=with_formula,
+            reported_only=reported_only,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -660,6 +689,7 @@ class AsReportedBalanceSheetApi:
         limit,
         offset,
         with_formula,
+        reported_only,
         _request_auth,
         _content_type,
         _headers,
@@ -706,6 +736,10 @@ class AsReportedBalanceSheetApi:
             
             _query_params.append(('with_formula', with_formula))
             
+        if reported_only is not None:
+            
+            _query_params.append(('reported_only', reported_only))
+            
         # process the header parameters
         # process the form parameters
         # process the body parameter
@@ -751,6 +785,7 @@ class AsReportedBalanceSheetApi:
         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,
+        reported_only: Annotated[Optional[StrictStr], Field(description="`true`: only the facts the company reported (`derived: false`); the pipeline's derived Q4 / TTM / YTD values are left out")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -778,6 +813,8 @@ class AsReportedBalanceSheetApi:
         :type limit: int
         :param offset: Number of periods to skip for pagination
         :type offset: int
+        :param reported_only: `true`: only the facts the company reported (`derived: false`); the pipeline's derived Q4 / TTM / YTD values are left out
+        :type reported_only: 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
@@ -806,6 +843,7 @@ class AsReportedBalanceSheetApi:
             sort=sort,
             limit=limit,
             offset=offset,
+            reported_only=reported_only,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -838,6 +876,7 @@ class AsReportedBalanceSheetApi:
         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,
+        reported_only: Annotated[Optional[StrictStr], Field(description="`true`: only the facts the company reported (`derived: false`); the pipeline's derived Q4 / TTM / YTD values are left out")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -865,6 +904,8 @@ class AsReportedBalanceSheetApi:
         :type limit: int
         :param offset: Number of periods to skip for pagination
         :type offset: int
+        :param reported_only: `true`: only the facts the company reported (`derived: false`); the pipeline's derived Q4 / TTM / YTD values are left out
+        :type reported_only: 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
@@ -893,6 +934,7 @@ class AsReportedBalanceSheetApi:
             sort=sort,
             limit=limit,
             offset=offset,
+            reported_only=reported_only,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -925,6 +967,7 @@ class AsReportedBalanceSheetApi:
         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,
+        reported_only: Annotated[Optional[StrictStr], Field(description="`true`: only the facts the company reported (`derived: false`); the pipeline's derived Q4 / TTM / YTD values are left out")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -952,6 +995,8 @@ class AsReportedBalanceSheetApi:
         :type limit: int
         :param offset: Number of periods to skip for pagination
         :type offset: int
+        :param reported_only: `true`: only the facts the company reported (`derived: false`); the pipeline's derived Q4 / TTM / YTD values are left out
+        :type reported_only: 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
@@ -980,6 +1025,7 @@ class AsReportedBalanceSheetApi:
             sort=sort,
             limit=limit,
             offset=offset,
+            reported_only=reported_only,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1007,6 +1053,7 @@ class AsReportedBalanceSheetApi:
         sort,
         limit,
         offset,
+        reported_only,
         _request_auth,
         _content_type,
         _headers,
@@ -1049,6 +1096,10 @@ class AsReportedBalanceSheetApi:
             
             _query_params.append(('offset', offset))
             
+        if reported_only is not None:
+            
+            _query_params.append(('reported_only', reported_only))
+            
         # process the header parameters
         # process the form parameters
         # process the body parameter