@robosystems/client 0.3.34 → 0.3.36
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/artifacts/LedgerClient.d.ts +79 -0
- package/artifacts/LedgerClient.js +135 -0
- package/artifacts/LedgerClient.ts +178 -0
- package/index.ts +2 -2
- package/package.json +1 -1
- package/sdk/index.d.ts +2 -2
- package/sdk/index.js +4 -3
- package/sdk/index.ts +2 -2
- package/sdk/sdk.gen.d.ts +7 -1
- package/sdk/sdk.gen.js +12 -1
- package/sdk/sdk.gen.ts +12 -1
- package/sdk/types.gen.d.ts +84 -0
- package/sdk/types.gen.ts +89 -0
- package/sdk.gen.d.ts +7 -1
- package/sdk.gen.js +12 -1
- package/sdk.gen.ts +12 -1
- package/types.gen.d.ts +84 -0
- package/types.gen.ts +89 -0
package/sdk/types.gen.d.ts
CHANGED
|
@@ -21458,6 +21458,90 @@ export type OpLiveFinancialStatementResponses = {
|
|
|
21458
21458
|
200: OperationEnvelope;
|
|
21459
21459
|
};
|
|
21460
21460
|
export type OpLiveFinancialStatementResponse = OpLiveFinancialStatementResponses[keyof OpLiveFinancialStatementResponses];
|
|
21461
|
+
export type GetReportBundleDownloadUrlData = {
|
|
21462
|
+
body?: never;
|
|
21463
|
+
path: {
|
|
21464
|
+
/**
|
|
21465
|
+
* Graph Id
|
|
21466
|
+
*/
|
|
21467
|
+
graph_id: string;
|
|
21468
|
+
/**
|
|
21469
|
+
* Report Id
|
|
21470
|
+
*
|
|
21471
|
+
* Report identifier (rpt_-prefixed ULID).
|
|
21472
|
+
*/
|
|
21473
|
+
report_id: string;
|
|
21474
|
+
};
|
|
21475
|
+
query?: {
|
|
21476
|
+
/**
|
|
21477
|
+
* Format
|
|
21478
|
+
*
|
|
21479
|
+
* Serialization flavor. ``jsonld`` returns a presigned URL to the stored JSON-LD bundle; ``xbrl-2.1`` streams a freshly-emitted XBRL zip directly. Other RDF / XBRL flavors slot in as their producers ship.
|
|
21480
|
+
*/
|
|
21481
|
+
format?: string;
|
|
21482
|
+
/**
|
|
21483
|
+
* Expires In
|
|
21484
|
+
*
|
|
21485
|
+
* Presigned URL lifetime in seconds (min 60, max 3600). Ignored for XBRL flavors (streamed directly, no URL).
|
|
21486
|
+
*/
|
|
21487
|
+
expires_in?: number;
|
|
21488
|
+
};
|
|
21489
|
+
url: '/extensions/roboledger/{graph_id}/reports/{report_id}/download';
|
|
21490
|
+
};
|
|
21491
|
+
export type GetReportBundleDownloadUrlErrors = {
|
|
21492
|
+
/**
|
|
21493
|
+
* Validation Error
|
|
21494
|
+
*/
|
|
21495
|
+
422: HttpValidationError;
|
|
21496
|
+
};
|
|
21497
|
+
export type GetReportBundleDownloadUrlError = GetReportBundleDownloadUrlErrors[keyof GetReportBundleDownloadUrlErrors];
|
|
21498
|
+
export type GetReportBundleDownloadUrlResponses = {
|
|
21499
|
+
/**
|
|
21500
|
+
* ReportBundleDownloadResponse
|
|
21501
|
+
*
|
|
21502
|
+
* Presigned-URL response for a Report bundle download.
|
|
21503
|
+
*
|
|
21504
|
+
* Mirrors :class:`BackupDownloadUrlResponse` in shape — the frontend
|
|
21505
|
+
* treats both the same way (fetch, follow URL, GET the artifact).
|
|
21506
|
+
*
|
|
21507
|
+
* Only returned for RDF-family flavors (JSON-LD) where the artifact
|
|
21508
|
+
* is stored in S3. XBRL flavors stream the binary content directly
|
|
21509
|
+
* in the response body (no JSON wrapper).
|
|
21510
|
+
*/
|
|
21511
|
+
200: {
|
|
21512
|
+
/**
|
|
21513
|
+
* Download Url
|
|
21514
|
+
*
|
|
21515
|
+
* Presigned URL that streams the bundle directly from S3.
|
|
21516
|
+
*/
|
|
21517
|
+
download_url: string;
|
|
21518
|
+
/**
|
|
21519
|
+
* Expires At
|
|
21520
|
+
*
|
|
21521
|
+
* UTC timestamp at which the presigned URL stops working.
|
|
21522
|
+
*/
|
|
21523
|
+
expires_at: string;
|
|
21524
|
+
/**
|
|
21525
|
+
* Content Type
|
|
21526
|
+
*
|
|
21527
|
+
* MIME type of the artifact behind the URL.
|
|
21528
|
+
*/
|
|
21529
|
+
content_type: string;
|
|
21530
|
+
/**
|
|
21531
|
+
* Format
|
|
21532
|
+
*
|
|
21533
|
+
* Serialization flavor delivered by this URL — matches the ``format`` query parameter.
|
|
21534
|
+
*/
|
|
21535
|
+
format: string;
|
|
21536
|
+
/**
|
|
21537
|
+
* Generation Count
|
|
21538
|
+
*
|
|
21539
|
+
* Bundle generation number stamped on the Report.
|
|
21540
|
+
*/
|
|
21541
|
+
generation_count: number;
|
|
21542
|
+
};
|
|
21543
|
+
};
|
|
21544
|
+
export type GetReportBundleDownloadUrlResponse = GetReportBundleDownloadUrlResponses[keyof GetReportBundleDownloadUrlResponses];
|
|
21461
21545
|
export type OpBuildFactGridData = {
|
|
21462
21546
|
body: CreateViewRequest;
|
|
21463
21547
|
headers?: {
|
package/sdk/types.gen.ts
CHANGED
|
@@ -22555,6 +22555,95 @@ export type OpLiveFinancialStatementResponses = {
|
|
|
22555
22555
|
|
|
22556
22556
|
export type OpLiveFinancialStatementResponse = OpLiveFinancialStatementResponses[keyof OpLiveFinancialStatementResponses];
|
|
22557
22557
|
|
|
22558
|
+
export type GetReportBundleDownloadUrlData = {
|
|
22559
|
+
body?: never;
|
|
22560
|
+
path: {
|
|
22561
|
+
/**
|
|
22562
|
+
* Graph Id
|
|
22563
|
+
*/
|
|
22564
|
+
graph_id: string;
|
|
22565
|
+
/**
|
|
22566
|
+
* Report Id
|
|
22567
|
+
*
|
|
22568
|
+
* Report identifier (rpt_-prefixed ULID).
|
|
22569
|
+
*/
|
|
22570
|
+
report_id: string;
|
|
22571
|
+
};
|
|
22572
|
+
query?: {
|
|
22573
|
+
/**
|
|
22574
|
+
* Format
|
|
22575
|
+
*
|
|
22576
|
+
* Serialization flavor. ``jsonld`` returns a presigned URL to the stored JSON-LD bundle; ``xbrl-2.1`` streams a freshly-emitted XBRL zip directly. Other RDF / XBRL flavors slot in as their producers ship.
|
|
22577
|
+
*/
|
|
22578
|
+
format?: string;
|
|
22579
|
+
/**
|
|
22580
|
+
* Expires In
|
|
22581
|
+
*
|
|
22582
|
+
* Presigned URL lifetime in seconds (min 60, max 3600). Ignored for XBRL flavors (streamed directly, no URL).
|
|
22583
|
+
*/
|
|
22584
|
+
expires_in?: number;
|
|
22585
|
+
};
|
|
22586
|
+
url: '/extensions/roboledger/{graph_id}/reports/{report_id}/download';
|
|
22587
|
+
};
|
|
22588
|
+
|
|
22589
|
+
export type GetReportBundleDownloadUrlErrors = {
|
|
22590
|
+
/**
|
|
22591
|
+
* Validation Error
|
|
22592
|
+
*/
|
|
22593
|
+
422: HttpValidationError;
|
|
22594
|
+
};
|
|
22595
|
+
|
|
22596
|
+
export type GetReportBundleDownloadUrlError = GetReportBundleDownloadUrlErrors[keyof GetReportBundleDownloadUrlErrors];
|
|
22597
|
+
|
|
22598
|
+
export type GetReportBundleDownloadUrlResponses = {
|
|
22599
|
+
/**
|
|
22600
|
+
* ReportBundleDownloadResponse
|
|
22601
|
+
*
|
|
22602
|
+
* Presigned-URL response for a Report bundle download.
|
|
22603
|
+
*
|
|
22604
|
+
* Mirrors :class:`BackupDownloadUrlResponse` in shape — the frontend
|
|
22605
|
+
* treats both the same way (fetch, follow URL, GET the artifact).
|
|
22606
|
+
*
|
|
22607
|
+
* Only returned for RDF-family flavors (JSON-LD) where the artifact
|
|
22608
|
+
* is stored in S3. XBRL flavors stream the binary content directly
|
|
22609
|
+
* in the response body (no JSON wrapper).
|
|
22610
|
+
*/
|
|
22611
|
+
200: {
|
|
22612
|
+
/**
|
|
22613
|
+
* Download Url
|
|
22614
|
+
*
|
|
22615
|
+
* Presigned URL that streams the bundle directly from S3.
|
|
22616
|
+
*/
|
|
22617
|
+
download_url: string;
|
|
22618
|
+
/**
|
|
22619
|
+
* Expires At
|
|
22620
|
+
*
|
|
22621
|
+
* UTC timestamp at which the presigned URL stops working.
|
|
22622
|
+
*/
|
|
22623
|
+
expires_at: string;
|
|
22624
|
+
/**
|
|
22625
|
+
* Content Type
|
|
22626
|
+
*
|
|
22627
|
+
* MIME type of the artifact behind the URL.
|
|
22628
|
+
*/
|
|
22629
|
+
content_type: string;
|
|
22630
|
+
/**
|
|
22631
|
+
* Format
|
|
22632
|
+
*
|
|
22633
|
+
* Serialization flavor delivered by this URL — matches the ``format`` query parameter.
|
|
22634
|
+
*/
|
|
22635
|
+
format: string;
|
|
22636
|
+
/**
|
|
22637
|
+
* Generation Count
|
|
22638
|
+
*
|
|
22639
|
+
* Bundle generation number stamped on the Report.
|
|
22640
|
+
*/
|
|
22641
|
+
generation_count: number;
|
|
22642
|
+
};
|
|
22643
|
+
};
|
|
22644
|
+
|
|
22645
|
+
export type GetReportBundleDownloadUrlResponse = GetReportBundleDownloadUrlResponses[keyof GetReportBundleDownloadUrlResponses];
|
|
22646
|
+
|
|
22558
22647
|
export type OpBuildFactGridData = {
|
|
22559
22648
|
body: CreateViewRequest;
|
|
22560
22649
|
headers?: {
|
package/sdk.gen.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { Client, Options as Options2, TDataShape } from './client';
|
|
2
|
-
import type { AutoSelectOperatorData, AutoSelectOperatorErrors, AutoSelectOperatorResponses, BatchProcessQueriesData, BatchProcessQueriesErrors, BatchProcessQueriesResponses, CallMcpToolData, CallMcpToolErrors, CallMcpToolResponses, CancelOperationData, CancelOperationErrors, CancelOperationResponses, CancelOrgSubscriptionData, CancelOrgSubscriptionErrors, CancelOrgSubscriptionResponses, CancelRepositorySubscriptionData, CancelRepositorySubscriptionErrors, CancelRepositorySubscriptionResponses, ChangeSubscriptionPlanData, ChangeSubscriptionPlanErrors, ChangeSubscriptionPlanResponses, CheckPasswordStrengthData, CheckPasswordStrengthErrors, CheckPasswordStrengthResponses, CompleteSsoAuthData, CompleteSsoAuthErrors, CompleteSsoAuthResponses, CreateCheckoutSessionData, CreateCheckoutSessionErrors, CreateCheckoutSessionResponses, CreateConnectionData, CreateConnectionErrors, CreateConnectionResponses, CreateFileUploadData, CreateFileUploadErrors, CreateFileUploadResponses, CreateGraphData, CreateGraphErrors, CreateGraphResponses, CreatePortalSessionData, CreatePortalSessionErrors, CreatePortalSessionResponses, CreateRepositorySubscriptionData, CreateRepositorySubscriptionErrors, CreateRepositorySubscriptionResponses, CreateUserApiKeyData, CreateUserApiKeyErrors, CreateUserApiKeyResponses, DeleteConnectionData, DeleteConnectionErrors, DeleteConnectionResponses, DeleteDocumentData, DeleteDocumentErrors, DeleteDocumentResponses, DeleteFileData, DeleteFileErrors, DeleteFileResponses, ExecuteCypherQueryData, ExecuteCypherQueryErrors, ExecuteCypherQueryResponses, ExecuteSpecificOperatorData, ExecuteSpecificOperatorErrors, ExecuteSpecificOperatorResponses, ExportGraphSchemaData, ExportGraphSchemaErrors, ExportGraphSchemaResponses, ForgotPasswordData, ForgotPasswordErrors, ForgotPasswordResponses, GenerateSsoTokenData, GenerateSsoTokenErrors, GenerateSsoTokenResponses, GetAvailableExtensionsData, GetAvailableExtensionsErrors, GetAvailableExtensionsResponses, GetAvailableGraphTiersData, GetAvailableGraphTiersErrors, GetAvailableGraphTiersResponses, GetBackupDownloadUrlData, GetBackupDownloadUrlErrors, GetBackupDownloadUrlResponses, GetBackupStatsData, GetBackupStatsErrors, GetBackupStatsResponses, GetCaptchaConfigData, GetCaptchaConfigErrors, GetCaptchaConfigResponses, GetCheckoutStatusData, GetCheckoutStatusErrors, GetCheckoutStatusResponses, GetConnectionData, GetConnectionErrors, GetConnectionOptionsData, GetConnectionOptionsErrors, GetConnectionOptionsResponses, GetConnectionResponses, GetCreditSummaryData, GetCreditSummaryErrors, GetCreditSummaryResponses, GetCurrentAuthUserData, GetCurrentAuthUserErrors, GetCurrentAuthUserResponses, GetCurrentUserData, GetCurrentUserErrors, GetCurrentUserResponses, GetDatabaseHealthData, GetDatabaseHealthErrors, GetDatabaseHealthResponses, GetDatabaseInfoData, GetDatabaseInfoErrors, GetDatabaseInfoResponses, GetDocumentData, GetDocumentErrors, GetDocumentResponses, GetDocumentSectionData, GetDocumentSectionErrors, GetDocumentSectionResponses, GetFileData, GetFileErrors, GetFileResponses, GetGraphCapacityData, GetGraphCapacityErrors, GetGraphCapacityResponses, GetGraphLimitsData, GetGraphLimitsErrors, GetGraphLimitsResponses, GetGraphMetricsData, GetGraphMetricsErrors, GetGraphMetricsResponses, GetGraphSchemaData, GetGraphSchemaErrors, GetGraphSchemaResponses, GetGraphsData, GetGraphsErrors, GetGraphsResponses, GetGraphSubscriptionData, GetGraphSubscriptionErrors, GetGraphSubscriptionResponses, GetGraphUsageAnalyticsData, GetGraphUsageAnalyticsErrors, GetGraphUsageAnalyticsResponses, GetOperationStatusData, GetOperationStatusErrors, GetOperationStatusResponses, GetOperatorMetadataData, GetOperatorMetadataErrors, GetOperatorMetadataResponses, GetOrgBillingCustomerData, GetOrgBillingCustomerErrors, GetOrgBillingCustomerResponses, GetOrgData, GetOrgErrors, GetOrgLimitsData, GetOrgLimitsErrors, GetOrgLimitsResponses, GetOrgResponses, GetOrgSubscriptionData, GetOrgSubscriptionErrors, GetOrgSubscriptionResponses, GetOrgUpcomingInvoiceData, GetOrgUpcomingInvoiceErrors, GetOrgUpcomingInvoiceResponses, GetOrgUsageData, GetOrgUsageErrors, GetOrgUsageResponses, GetPasswordPolicyData, GetPasswordPolicyErrors, GetPasswordPolicyResponses, GetServiceOfferingsData, GetServiceOfferingsErrors, GetServiceOfferingsResponses, GetServiceStatusData, GetServiceStatusResponses, GetSubgraphInfoData, GetSubgraphInfoErrors, GetSubgraphInfoResponses, GetSubgraphQuotaData, GetSubgraphQuotaErrors, GetSubgraphQuotaResponses, HandleHttpGetExtensionsGraphIdGraphqlGetData, HandleHttpGetExtensionsGraphIdGraphqlGetErrors, HandleHttpGetExtensionsGraphIdGraphqlGetResponses, HandleHttpPostExtensionsGraphIdGraphqlPostData, HandleHttpPostExtensionsGraphIdGraphqlPostErrors, HandleHttpPostExtensionsGraphIdGraphqlPostResponses, InitOAuthData, InitOAuthErrors, InitOAuthResponses, InviteOrgMemberData, InviteOrgMemberErrors, InviteOrgMemberResponses, ListBackupsData, ListBackupsErrors, ListBackupsResponses, ListConnectionsData, ListConnectionsErrors, ListConnectionsResponses, ListCreditTransactionsData, ListCreditTransactionsErrors, ListCreditTransactionsResponses, ListDocumentsData, ListDocumentsErrors, ListDocumentsResponses, ListFilesData, ListFilesErrors, ListFilesResponses, ListMcpToolsData, ListMcpToolsErrors, ListMcpToolsResponses, ListOperatorsData, ListOperatorsErrors, ListOperatorsResponses, ListOrgGraphsData, ListOrgGraphsErrors, ListOrgGraphsResponses, ListOrgInvoicesData, ListOrgInvoicesErrors, ListOrgInvoicesResponses, ListOrgMembersData, ListOrgMembersErrors, ListOrgMembersResponses, ListOrgSubscriptionsData, ListOrgSubscriptionsErrors, ListOrgSubscriptionsResponses, ListSubgraphsData, ListSubgraphsErrors, ListSubgraphsResponses, ListTablesData, ListTablesErrors, ListTablesResponses, ListUserApiKeysData, ListUserApiKeysErrors, ListUserApiKeysResponses, ListUserOrgsData, ListUserOrgsErrors, ListUserOrgsResponses, LoginUserData, LoginUserErrors, LoginUserResponses, LogoutUserData, LogoutUserErrors, LogoutUserResponses, OauthCallbackData, OauthCallbackErrors, OauthCallbackResponses, OpAddPublishListMembersData, OpAddPublishListMembersErrors, OpAddPublishListMembersResponses, OpAutoMapElementsData, OpAutoMapElementsErrors, OpAutoMapElementsResponses, OpBuildFactGridData, OpBuildFactGridErrors, OpBuildFactGridResponses, OpChangeReportingStyleData, OpChangeReportingStyleErrors, OpChangeReportingStyleResponses, OpChangeTierData, OpChangeTierErrors, OpChangeTierResponses, OpClosePeriodData, OpClosePeriodErrors, OpClosePeriodResponses, OpCreateAgentData, OpCreateAgentErrors, OpCreateAgentResponses, OpCreateBackupData, OpCreateBackupErrors, OpCreateBackupResponses, OpCreateEventBlockData, OpCreateEventBlockErrors, OpCreateEventBlockResponses, OpCreateEventHandlerData, OpCreateEventHandlerErrors, OpCreateEventHandlerResponses, OpCreateInformationBlockData, OpCreateInformationBlockErrors, OpCreateInformationBlockResponses, OpCreateMappingAssociationData, OpCreateMappingAssociationErrors, OpCreateMappingAssociationResponses, OpCreatePortfolioBlockData, OpCreatePortfolioBlockErrors, OpCreatePortfolioBlockResponses, OpCreatePublishListData, OpCreatePublishListErrors, OpCreatePublishListResponses, OpCreateReportData, OpCreateReportErrors, OpCreateReportResponses, OpCreateSecurityData, OpCreateSecurityErrors, OpCreateSecurityResponses, OpCreateSubgraphData, OpCreateSubgraphErrors, OpCreateSubgraphResponses, OpCreateTaxonomyBlockData, OpCreateTaxonomyBlockErrors, OpCreateTaxonomyBlockResponses, OpDeleteGraphData, OpDeleteGraphErrors, OpDeleteGraphResponses, OpDeleteInformationBlockData, OpDeleteInformationBlockErrors, OpDeleteInformationBlockResponses, OpDeleteJournalEntryData, OpDeleteJournalEntryErrors, OpDeleteJournalEntryResponses, OpDeleteMappingAssociationData, OpDeleteMappingAssociationErrors, OpDeleteMappingAssociationResponses, OpDeletePortfolioBlockData, OpDeletePortfolioBlockErrors, OpDeletePortfolioBlockResponses, OpDeletePublishListData, OpDeletePublishListErrors, OpDeletePublishListResponses, OpDeleteReportData, OpDeleteReportErrors, OpDeleteReportResponses, OpDeleteSecurityData, OpDeleteSecurityErrors, OpDeleteSecurityResponses, OpDeleteSubgraphData, OpDeleteSubgraphErrors, OpDeleteSubgraphResponses, OpDeleteTaxonomyBlockData, OpDeleteTaxonomyBlockErrors, OpDeleteTaxonomyBlockResponses, OpEvaluateRulesData, OpEvaluateRulesErrors, OpEvaluateRulesResponses, OpExecuteEventBlockData, OpExecuteEventBlockErrors, OpExecuteEventBlockResponses, OpFileReportData, OpFileReportErrors, OpFileReportResponses, OpFinancialStatementAnalysisData, OpFinancialStatementAnalysisErrors, OpFinancialStatementAnalysisResponses, OpInitializeLedgerData, OpInitializeLedgerErrors, OpInitializeLedgerResponses, OpLinkEntityTaxonomyData, OpLinkEntityTaxonomyErrors, OpLinkEntityTaxonomyResponses, OpLiveFinancialStatementData, OpLiveFinancialStatementErrors, OpLiveFinancialStatementResponses, OpMaterializeData, OpMaterializeErrors, OpMaterializeResponses, OpPreviewEventBlockData, OpPreviewEventBlockErrors, OpPreviewEventBlockResponses, OpRegenerateReportData, OpRegenerateReportErrors, OpRegenerateReportResponses, OpRemovePublishListMemberData, OpRemovePublishListMemberErrors, OpRemovePublishListMemberResponses, OpReopenPeriodData, OpReopenPeriodErrors, OpReopenPeriodResponses, OpRestoreBackupData, OpRestoreBackupErrors, OpRestoreBackupResponses, OpSetCloseTargetData, OpSetCloseTargetErrors, OpSetCloseTargetResponses, OpShareReportData, OpShareReportErrors, OpShareReportResponses, OpTransitionFilingStatusData, OpTransitionFilingStatusErrors, OpTransitionFilingStatusResponses, OpUpdateAgentData, OpUpdateAgentErrors, OpUpdateAgentResponses, OpUpdateEntityData, OpUpdateEntityErrors, OpUpdateEntityResponses, OpUpdateEventBlockData, OpUpdateEventBlockErrors, OpUpdateEventBlockResponses, OpUpdateEventHandlerData, OpUpdateEventHandlerErrors, OpUpdateEventHandlerResponses, OpUpdateInformationBlockData, OpUpdateInformationBlockErrors, OpUpdateInformationBlockResponses, OpUpdateJournalEntryData, OpUpdateJournalEntryErrors, OpUpdateJournalEntryResponses, OpUpdatePortfolioBlockData, OpUpdatePortfolioBlockErrors, OpUpdatePortfolioBlockResponses, OpUpdatePublishListData, OpUpdatePublishListErrors, OpUpdatePublishListResponses, OpUpdateSecurityData, OpUpdateSecurityErrors, OpUpdateSecurityResponses, OpUpdateTaxonomyBlockData, OpUpdateTaxonomyBlockErrors, OpUpdateTaxonomyBlockResponses, QueryTablesData, QueryTablesErrors, QueryTablesResponses, RecommendOperatorData, RecommendOperatorErrors, RecommendOperatorResponses, RefreshAuthSessionData, RefreshAuthSessionErrors, RefreshAuthSessionResponses, RegisterUserData, RegisterUserErrors, RegisterUserResponses, RemoveOrgMemberData, RemoveOrgMemberErrors, RemoveOrgMemberResponses, ResendVerificationEmailData, ResendVerificationEmailErrors, ResendVerificationEmailResponses, ResetPasswordData, ResetPasswordErrors, ResetPasswordResponses, RevokeUserApiKeyData, RevokeUserApiKeyErrors, RevokeUserApiKeyResponses, SearchDocumentsData, SearchDocumentsErrors, SearchDocumentsResponses, SelectGraphData, SelectGraphErrors, SelectGraphResponses, SsoTokenExchangeData, SsoTokenExchangeErrors, SsoTokenExchangeResponses, StreamOperationEventsData, StreamOperationEventsErrors, StreamOperationEventsResponses, SyncConnectionData, SyncConnectionErrors, SyncConnectionResponses, UpdateDocumentData, UpdateDocumentErrors, UpdateDocumentResponses, UpdateFileData, UpdateFileErrors, UpdateFileResponses, UpdateOrgData, UpdateOrgErrors, UpdateOrgMemberRoleData, UpdateOrgMemberRoleErrors, UpdateOrgMemberRoleResponses, UpdateOrgResponses, UpdateUserApiKeyData, UpdateUserApiKeyErrors, UpdateUserApiKeyResponses, UpdateUserData, UpdateUserErrors, UpdateUserPasswordData, UpdateUserPasswordErrors, UpdateUserPasswordResponses, UpdateUserResponses, UploadDocumentData, UploadDocumentErrors, UploadDocumentResponses, ValidateResetTokenData, ValidateResetTokenErrors, ValidateResetTokenResponses, ValidateSchemaData, ValidateSchemaErrors, ValidateSchemaResponses, VerifyEmailData, VerifyEmailErrors, VerifyEmailResponses } from './types.gen';
|
|
2
|
+
import type { AutoSelectOperatorData, AutoSelectOperatorErrors, AutoSelectOperatorResponses, BatchProcessQueriesData, BatchProcessQueriesErrors, BatchProcessQueriesResponses, CallMcpToolData, CallMcpToolErrors, CallMcpToolResponses, CancelOperationData, CancelOperationErrors, CancelOperationResponses, CancelOrgSubscriptionData, CancelOrgSubscriptionErrors, CancelOrgSubscriptionResponses, CancelRepositorySubscriptionData, CancelRepositorySubscriptionErrors, CancelRepositorySubscriptionResponses, ChangeSubscriptionPlanData, ChangeSubscriptionPlanErrors, ChangeSubscriptionPlanResponses, CheckPasswordStrengthData, CheckPasswordStrengthErrors, CheckPasswordStrengthResponses, CompleteSsoAuthData, CompleteSsoAuthErrors, CompleteSsoAuthResponses, CreateCheckoutSessionData, CreateCheckoutSessionErrors, CreateCheckoutSessionResponses, CreateConnectionData, CreateConnectionErrors, CreateConnectionResponses, CreateFileUploadData, CreateFileUploadErrors, CreateFileUploadResponses, CreateGraphData, CreateGraphErrors, CreateGraphResponses, CreatePortalSessionData, CreatePortalSessionErrors, CreatePortalSessionResponses, CreateRepositorySubscriptionData, CreateRepositorySubscriptionErrors, CreateRepositorySubscriptionResponses, CreateUserApiKeyData, CreateUserApiKeyErrors, CreateUserApiKeyResponses, DeleteConnectionData, DeleteConnectionErrors, DeleteConnectionResponses, DeleteDocumentData, DeleteDocumentErrors, DeleteDocumentResponses, DeleteFileData, DeleteFileErrors, DeleteFileResponses, ExecuteCypherQueryData, ExecuteCypherQueryErrors, ExecuteCypherQueryResponses, ExecuteSpecificOperatorData, ExecuteSpecificOperatorErrors, ExecuteSpecificOperatorResponses, ExportGraphSchemaData, ExportGraphSchemaErrors, ExportGraphSchemaResponses, ForgotPasswordData, ForgotPasswordErrors, ForgotPasswordResponses, GenerateSsoTokenData, GenerateSsoTokenErrors, GenerateSsoTokenResponses, GetAvailableExtensionsData, GetAvailableExtensionsErrors, GetAvailableExtensionsResponses, GetAvailableGraphTiersData, GetAvailableGraphTiersErrors, GetAvailableGraphTiersResponses, GetBackupDownloadUrlData, GetBackupDownloadUrlErrors, GetBackupDownloadUrlResponses, GetBackupStatsData, GetBackupStatsErrors, GetBackupStatsResponses, GetCaptchaConfigData, GetCaptchaConfigErrors, GetCaptchaConfigResponses, GetCheckoutStatusData, GetCheckoutStatusErrors, GetCheckoutStatusResponses, GetConnectionData, GetConnectionErrors, GetConnectionOptionsData, GetConnectionOptionsErrors, GetConnectionOptionsResponses, GetConnectionResponses, GetCreditSummaryData, GetCreditSummaryErrors, GetCreditSummaryResponses, GetCurrentAuthUserData, GetCurrentAuthUserErrors, GetCurrentAuthUserResponses, GetCurrentUserData, GetCurrentUserErrors, GetCurrentUserResponses, GetDatabaseHealthData, GetDatabaseHealthErrors, GetDatabaseHealthResponses, GetDatabaseInfoData, GetDatabaseInfoErrors, GetDatabaseInfoResponses, GetDocumentData, GetDocumentErrors, GetDocumentResponses, GetDocumentSectionData, GetDocumentSectionErrors, GetDocumentSectionResponses, GetFileData, GetFileErrors, GetFileResponses, GetGraphCapacityData, GetGraphCapacityErrors, GetGraphCapacityResponses, GetGraphLimitsData, GetGraphLimitsErrors, GetGraphLimitsResponses, GetGraphMetricsData, GetGraphMetricsErrors, GetGraphMetricsResponses, GetGraphSchemaData, GetGraphSchemaErrors, GetGraphSchemaResponses, GetGraphsData, GetGraphsErrors, GetGraphsResponses, GetGraphSubscriptionData, GetGraphSubscriptionErrors, GetGraphSubscriptionResponses, GetGraphUsageAnalyticsData, GetGraphUsageAnalyticsErrors, GetGraphUsageAnalyticsResponses, GetOperationStatusData, GetOperationStatusErrors, GetOperationStatusResponses, GetOperatorMetadataData, GetOperatorMetadataErrors, GetOperatorMetadataResponses, GetOrgBillingCustomerData, GetOrgBillingCustomerErrors, GetOrgBillingCustomerResponses, GetOrgData, GetOrgErrors, GetOrgLimitsData, GetOrgLimitsErrors, GetOrgLimitsResponses, GetOrgResponses, GetOrgSubscriptionData, GetOrgSubscriptionErrors, GetOrgSubscriptionResponses, GetOrgUpcomingInvoiceData, GetOrgUpcomingInvoiceErrors, GetOrgUpcomingInvoiceResponses, GetOrgUsageData, GetOrgUsageErrors, GetOrgUsageResponses, GetPasswordPolicyData, GetPasswordPolicyErrors, GetPasswordPolicyResponses, GetReportBundleDownloadUrlData, GetReportBundleDownloadUrlErrors, GetReportBundleDownloadUrlResponses, GetServiceOfferingsData, GetServiceOfferingsErrors, GetServiceOfferingsResponses, GetServiceStatusData, GetServiceStatusResponses, GetSubgraphInfoData, GetSubgraphInfoErrors, GetSubgraphInfoResponses, GetSubgraphQuotaData, GetSubgraphQuotaErrors, GetSubgraphQuotaResponses, HandleHttpGetExtensionsGraphIdGraphqlGetData, HandleHttpGetExtensionsGraphIdGraphqlGetErrors, HandleHttpGetExtensionsGraphIdGraphqlGetResponses, HandleHttpPostExtensionsGraphIdGraphqlPostData, HandleHttpPostExtensionsGraphIdGraphqlPostErrors, HandleHttpPostExtensionsGraphIdGraphqlPostResponses, InitOAuthData, InitOAuthErrors, InitOAuthResponses, InviteOrgMemberData, InviteOrgMemberErrors, InviteOrgMemberResponses, ListBackupsData, ListBackupsErrors, ListBackupsResponses, ListConnectionsData, ListConnectionsErrors, ListConnectionsResponses, ListCreditTransactionsData, ListCreditTransactionsErrors, ListCreditTransactionsResponses, ListDocumentsData, ListDocumentsErrors, ListDocumentsResponses, ListFilesData, ListFilesErrors, ListFilesResponses, ListMcpToolsData, ListMcpToolsErrors, ListMcpToolsResponses, ListOperatorsData, ListOperatorsErrors, ListOperatorsResponses, ListOrgGraphsData, ListOrgGraphsErrors, ListOrgGraphsResponses, ListOrgInvoicesData, ListOrgInvoicesErrors, ListOrgInvoicesResponses, ListOrgMembersData, ListOrgMembersErrors, ListOrgMembersResponses, ListOrgSubscriptionsData, ListOrgSubscriptionsErrors, ListOrgSubscriptionsResponses, ListSubgraphsData, ListSubgraphsErrors, ListSubgraphsResponses, ListTablesData, ListTablesErrors, ListTablesResponses, ListUserApiKeysData, ListUserApiKeysErrors, ListUserApiKeysResponses, ListUserOrgsData, ListUserOrgsErrors, ListUserOrgsResponses, LoginUserData, LoginUserErrors, LoginUserResponses, LogoutUserData, LogoutUserErrors, LogoutUserResponses, OauthCallbackData, OauthCallbackErrors, OauthCallbackResponses, OpAddPublishListMembersData, OpAddPublishListMembersErrors, OpAddPublishListMembersResponses, OpAutoMapElementsData, OpAutoMapElementsErrors, OpAutoMapElementsResponses, OpBuildFactGridData, OpBuildFactGridErrors, OpBuildFactGridResponses, OpChangeReportingStyleData, OpChangeReportingStyleErrors, OpChangeReportingStyleResponses, OpChangeTierData, OpChangeTierErrors, OpChangeTierResponses, OpClosePeriodData, OpClosePeriodErrors, OpClosePeriodResponses, OpCreateAgentData, OpCreateAgentErrors, OpCreateAgentResponses, OpCreateBackupData, OpCreateBackupErrors, OpCreateBackupResponses, OpCreateEventBlockData, OpCreateEventBlockErrors, OpCreateEventBlockResponses, OpCreateEventHandlerData, OpCreateEventHandlerErrors, OpCreateEventHandlerResponses, OpCreateInformationBlockData, OpCreateInformationBlockErrors, OpCreateInformationBlockResponses, OpCreateMappingAssociationData, OpCreateMappingAssociationErrors, OpCreateMappingAssociationResponses, OpCreatePortfolioBlockData, OpCreatePortfolioBlockErrors, OpCreatePortfolioBlockResponses, OpCreatePublishListData, OpCreatePublishListErrors, OpCreatePublishListResponses, OpCreateReportData, OpCreateReportErrors, OpCreateReportResponses, OpCreateSecurityData, OpCreateSecurityErrors, OpCreateSecurityResponses, OpCreateSubgraphData, OpCreateSubgraphErrors, OpCreateSubgraphResponses, OpCreateTaxonomyBlockData, OpCreateTaxonomyBlockErrors, OpCreateTaxonomyBlockResponses, OpDeleteGraphData, OpDeleteGraphErrors, OpDeleteGraphResponses, OpDeleteInformationBlockData, OpDeleteInformationBlockErrors, OpDeleteInformationBlockResponses, OpDeleteJournalEntryData, OpDeleteJournalEntryErrors, OpDeleteJournalEntryResponses, OpDeleteMappingAssociationData, OpDeleteMappingAssociationErrors, OpDeleteMappingAssociationResponses, OpDeletePortfolioBlockData, OpDeletePortfolioBlockErrors, OpDeletePortfolioBlockResponses, OpDeletePublishListData, OpDeletePublishListErrors, OpDeletePublishListResponses, OpDeleteReportData, OpDeleteReportErrors, OpDeleteReportResponses, OpDeleteSecurityData, OpDeleteSecurityErrors, OpDeleteSecurityResponses, OpDeleteSubgraphData, OpDeleteSubgraphErrors, OpDeleteSubgraphResponses, OpDeleteTaxonomyBlockData, OpDeleteTaxonomyBlockErrors, OpDeleteTaxonomyBlockResponses, OpEvaluateRulesData, OpEvaluateRulesErrors, OpEvaluateRulesResponses, OpExecuteEventBlockData, OpExecuteEventBlockErrors, OpExecuteEventBlockResponses, OpFileReportData, OpFileReportErrors, OpFileReportResponses, OpFinancialStatementAnalysisData, OpFinancialStatementAnalysisErrors, OpFinancialStatementAnalysisResponses, OpInitializeLedgerData, OpInitializeLedgerErrors, OpInitializeLedgerResponses, OpLinkEntityTaxonomyData, OpLinkEntityTaxonomyErrors, OpLinkEntityTaxonomyResponses, OpLiveFinancialStatementData, OpLiveFinancialStatementErrors, OpLiveFinancialStatementResponses, OpMaterializeData, OpMaterializeErrors, OpMaterializeResponses, OpPreviewEventBlockData, OpPreviewEventBlockErrors, OpPreviewEventBlockResponses, OpRegenerateReportData, OpRegenerateReportErrors, OpRegenerateReportResponses, OpRemovePublishListMemberData, OpRemovePublishListMemberErrors, OpRemovePublishListMemberResponses, OpReopenPeriodData, OpReopenPeriodErrors, OpReopenPeriodResponses, OpRestoreBackupData, OpRestoreBackupErrors, OpRestoreBackupResponses, OpSetCloseTargetData, OpSetCloseTargetErrors, OpSetCloseTargetResponses, OpShareReportData, OpShareReportErrors, OpShareReportResponses, OpTransitionFilingStatusData, OpTransitionFilingStatusErrors, OpTransitionFilingStatusResponses, OpUpdateAgentData, OpUpdateAgentErrors, OpUpdateAgentResponses, OpUpdateEntityData, OpUpdateEntityErrors, OpUpdateEntityResponses, OpUpdateEventBlockData, OpUpdateEventBlockErrors, OpUpdateEventBlockResponses, OpUpdateEventHandlerData, OpUpdateEventHandlerErrors, OpUpdateEventHandlerResponses, OpUpdateInformationBlockData, OpUpdateInformationBlockErrors, OpUpdateInformationBlockResponses, OpUpdateJournalEntryData, OpUpdateJournalEntryErrors, OpUpdateJournalEntryResponses, OpUpdatePortfolioBlockData, OpUpdatePortfolioBlockErrors, OpUpdatePortfolioBlockResponses, OpUpdatePublishListData, OpUpdatePublishListErrors, OpUpdatePublishListResponses, OpUpdateSecurityData, OpUpdateSecurityErrors, OpUpdateSecurityResponses, OpUpdateTaxonomyBlockData, OpUpdateTaxonomyBlockErrors, OpUpdateTaxonomyBlockResponses, QueryTablesData, QueryTablesErrors, QueryTablesResponses, RecommendOperatorData, RecommendOperatorErrors, RecommendOperatorResponses, RefreshAuthSessionData, RefreshAuthSessionErrors, RefreshAuthSessionResponses, RegisterUserData, RegisterUserErrors, RegisterUserResponses, RemoveOrgMemberData, RemoveOrgMemberErrors, RemoveOrgMemberResponses, ResendVerificationEmailData, ResendVerificationEmailErrors, ResendVerificationEmailResponses, ResetPasswordData, ResetPasswordErrors, ResetPasswordResponses, RevokeUserApiKeyData, RevokeUserApiKeyErrors, RevokeUserApiKeyResponses, SearchDocumentsData, SearchDocumentsErrors, SearchDocumentsResponses, SelectGraphData, SelectGraphErrors, SelectGraphResponses, SsoTokenExchangeData, SsoTokenExchangeErrors, SsoTokenExchangeResponses, StreamOperationEventsData, StreamOperationEventsErrors, StreamOperationEventsResponses, SyncConnectionData, SyncConnectionErrors, SyncConnectionResponses, UpdateDocumentData, UpdateDocumentErrors, UpdateDocumentResponses, UpdateFileData, UpdateFileErrors, UpdateFileResponses, UpdateOrgData, UpdateOrgErrors, UpdateOrgMemberRoleData, UpdateOrgMemberRoleErrors, UpdateOrgMemberRoleResponses, UpdateOrgResponses, UpdateUserApiKeyData, UpdateUserApiKeyErrors, UpdateUserApiKeyResponses, UpdateUserData, UpdateUserErrors, UpdateUserPasswordData, UpdateUserPasswordErrors, UpdateUserPasswordResponses, UpdateUserResponses, UploadDocumentData, UploadDocumentErrors, UploadDocumentResponses, ValidateResetTokenData, ValidateResetTokenErrors, ValidateResetTokenResponses, ValidateSchemaData, ValidateSchemaErrors, ValidateSchemaResponses, VerifyEmailData, VerifyEmailErrors, VerifyEmailResponses } from './types.gen';
|
|
3
3
|
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
|
|
4
4
|
/**
|
|
5
5
|
* You can provide a client instance returned by `createClient()` instead of
|
|
@@ -955,6 +955,12 @@ export declare const opRemovePublishListMember: <ThrowOnError extends boolean =
|
|
|
955
955
|
* **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
|
|
956
956
|
*/
|
|
957
957
|
export declare const opLiveFinancialStatement: <ThrowOnError extends boolean = false>(options: Options<OpLiveFinancialStatementData, ThrowOnError>) => import("./client").RequestResult<OpLiveFinancialStatementResponses, OpLiveFinancialStatementErrors, ThrowOnError, "fields">;
|
|
958
|
+
/**
|
|
959
|
+
* Download Report bundle
|
|
960
|
+
*
|
|
961
|
+
* Return the published Report's serialization bundle. ``format=jsonld`` (default) returns a JSON envelope containing a short-lived presigned URL to the stamped JSON-LD bundle in S3. ``format=xbrl-2.1`` rebuilds the bundle on-demand and streams an XBRL 2.1 zip directly. 404 when the Report has no stamped bundle (published before the serialization feature shipped — JSON-LD only).
|
|
962
|
+
*/
|
|
963
|
+
export declare const getReportBundleDownloadUrl: <ThrowOnError extends boolean = false>(options: Options<GetReportBundleDownloadUrlData, ThrowOnError>) => import("./client").RequestResult<GetReportBundleDownloadUrlResponses, GetReportBundleDownloadUrlErrors, ThrowOnError, "fields">;
|
|
958
964
|
/**
|
|
959
965
|
* Build Fact Grid
|
|
960
966
|
*
|
package/sdk.gen.js
CHANGED
|
@@ -4,7 +4,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
4
4
|
exports.callMcpTool = exports.listMcpTools = exports.recommendOperator = exports.batchProcessQueries = exports.executeSpecificOperator = exports.getOperatorMetadata = exports.autoSelectOperator = exports.listOperators = exports.syncConnection = exports.getConnection = exports.deleteConnection = exports.oauthCallback = exports.initOAuth = exports.getConnectionOptions = exports.createConnection = exports.listConnections = exports.getOrgUsage = exports.getOrgLimits = exports.updateOrgMemberRole = exports.removeOrgMember = exports.inviteOrgMember = exports.listOrgMembers = exports.listOrgGraphs = exports.updateOrg = exports.getOrg = exports.listUserOrgs = exports.updateUserApiKey = exports.revokeUserApiKey = exports.createUserApiKey = exports.listUserApiKeys = exports.updateUserPassword = exports.updateUser = exports.getCurrentUser = exports.getServiceStatus = exports.getCaptchaConfig = exports.completeSsoAuth = exports.ssoTokenExchange = exports.generateSsoToken = exports.resetPassword = exports.validateResetToken = exports.forgotPassword = exports.checkPasswordStrength = exports.getPasswordPolicy = exports.verifyEmail = exports.resendVerificationEmail = exports.refreshAuthSession = exports.getCurrentAuthUser = exports.logoutUser = exports.loginUser = exports.registerUser = void 0;
|
|
5
5
|
exports.getServiceOfferings = exports.selectGraph = exports.getGraphCapacity = exports.getAvailableGraphTiers = exports.getAvailableExtensions = exports.createGraph = exports.getGraphs = exports.updateFile = exports.getFile = exports.deleteFile = exports.createFileUpload = exports.listFiles = exports.opMaterialize = exports.opChangeReportingStyle = exports.opChangeTier = exports.opRestoreBackup = exports.opCreateBackup = exports.opDeleteGraph = exports.opDeleteSubgraph = exports.opCreateSubgraph = exports.updateDocument = exports.getDocument = exports.deleteDocument = exports.uploadDocument = exports.listDocuments = exports.getDocumentSection = exports.searchDocuments = exports.queryTables = exports.listTables = exports.cancelRepositorySubscription = exports.createRepositorySubscription = exports.changeSubscriptionPlan = exports.getGraphSubscription = exports.getSubgraphQuota = exports.getSubgraphInfo = exports.listSubgraphs = exports.getGraphLimits = exports.getDatabaseInfo = exports.getDatabaseHealth = exports.listCreditTransactions = exports.getCreditSummary = exports.validateSchema = exports.exportGraphSchema = exports.getGraphSchema = exports.executeCypherQuery = exports.getGraphUsageAnalytics = exports.getGraphMetrics = exports.getBackupStats = exports.getBackupDownloadUrl = exports.listBackups = void 0;
|
|
6
6
|
exports.opAddPublishListMembers = exports.opDeletePublishList = exports.opUpdatePublishList = exports.opCreatePublishList = exports.opTransitionFilingStatus = exports.opFileReport = exports.opShareReport = exports.opDeleteReport = exports.opRegenerateReport = exports.opCreateReport = exports.opReopenPeriod = exports.opClosePeriod = exports.opSetCloseTarget = exports.opDeleteJournalEntry = exports.opUpdateJournalEntry = exports.opPreviewEventBlock = exports.opUpdateEventHandler = exports.opCreateEventHandler = exports.opExecuteEventBlock = exports.opUpdateEventBlock = exports.opCreateEventBlock = exports.opUpdateAgent = exports.opCreateAgent = exports.opEvaluateRules = exports.opDeleteInformationBlock = exports.opUpdateInformationBlock = exports.opCreateInformationBlock = exports.opAutoMapElements = exports.opDeleteMappingAssociation = exports.opCreateMappingAssociation = exports.opLinkEntityTaxonomy = exports.opDeleteTaxonomyBlock = exports.opUpdateTaxonomyBlock = exports.opCreateTaxonomyBlock = exports.opUpdateEntity = exports.opInitializeLedger = exports.handleHttpPostExtensionsGraphIdGraphqlPost = exports.handleHttpGetExtensionsGraphIdGraphqlGet = exports.getCheckoutStatus = exports.createCheckoutSession = exports.getOrgUpcomingInvoice = exports.listOrgInvoices = exports.cancelOrgSubscription = exports.getOrgSubscription = exports.listOrgSubscriptions = exports.createPortalSession = exports.getOrgBillingCustomer = exports.cancelOperation = exports.getOperationStatus = exports.streamOperationEvents = void 0;
|
|
7
|
-
exports.opDeleteSecurity = exports.opUpdateSecurity = exports.opCreateSecurity = exports.opDeletePortfolioBlock = exports.opUpdatePortfolioBlock = exports.opCreatePortfolioBlock = exports.opFinancialStatementAnalysis = exports.opBuildFactGrid = exports.opLiveFinancialStatement = exports.opRemovePublishListMember = void 0;
|
|
7
|
+
exports.opDeleteSecurity = exports.opUpdateSecurity = exports.opCreateSecurity = exports.opDeletePortfolioBlock = exports.opUpdatePortfolioBlock = exports.opCreatePortfolioBlock = exports.opFinancialStatementAnalysis = exports.opBuildFactGrid = exports.getReportBundleDownloadUrl = exports.opLiveFinancialStatement = exports.opRemovePublishListMember = void 0;
|
|
8
8
|
const client_gen_1 = require("./client.gen");
|
|
9
9
|
/**
|
|
10
10
|
* Register New User
|
|
@@ -1996,6 +1996,17 @@ const opLiveFinancialStatement = (options) => (options.client ?? client_gen_1.cl
|
|
|
1996
1996
|
}
|
|
1997
1997
|
});
|
|
1998
1998
|
exports.opLiveFinancialStatement = opLiveFinancialStatement;
|
|
1999
|
+
/**
|
|
2000
|
+
* Download Report bundle
|
|
2001
|
+
*
|
|
2002
|
+
* Return the published Report's serialization bundle. ``format=jsonld`` (default) returns a JSON envelope containing a short-lived presigned URL to the stamped JSON-LD bundle in S3. ``format=xbrl-2.1`` rebuilds the bundle on-demand and streams an XBRL 2.1 zip directly. 404 when the Report has no stamped bundle (published before the serialization feature shipped — JSON-LD only).
|
|
2003
|
+
*/
|
|
2004
|
+
const getReportBundleDownloadUrl = (options) => (options.client ?? client_gen_1.client).get({
|
|
2005
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2006
|
+
url: '/extensions/roboledger/{graph_id}/reports/{report_id}/download',
|
|
2007
|
+
...options
|
|
2008
|
+
});
|
|
2009
|
+
exports.getReportBundleDownloadUrl = getReportBundleDownloadUrl;
|
|
1999
2010
|
/**
|
|
2000
2011
|
* Build Fact Grid
|
|
2001
2012
|
*
|
package/sdk.gen.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
import type { Client, Options as Options2, TDataShape } from './client';
|
|
4
4
|
import { client } from './client.gen';
|
|
5
|
-
import type { AutoSelectOperatorData, AutoSelectOperatorErrors, AutoSelectOperatorResponses, BatchProcessQueriesData, BatchProcessQueriesErrors, BatchProcessQueriesResponses, CallMcpToolData, CallMcpToolErrors, CallMcpToolResponses, CancelOperationData, CancelOperationErrors, CancelOperationResponses, CancelOrgSubscriptionData, CancelOrgSubscriptionErrors, CancelOrgSubscriptionResponses, CancelRepositorySubscriptionData, CancelRepositorySubscriptionErrors, CancelRepositorySubscriptionResponses, ChangeSubscriptionPlanData, ChangeSubscriptionPlanErrors, ChangeSubscriptionPlanResponses, CheckPasswordStrengthData, CheckPasswordStrengthErrors, CheckPasswordStrengthResponses, CompleteSsoAuthData, CompleteSsoAuthErrors, CompleteSsoAuthResponses, CreateCheckoutSessionData, CreateCheckoutSessionErrors, CreateCheckoutSessionResponses, CreateConnectionData, CreateConnectionErrors, CreateConnectionResponses, CreateFileUploadData, CreateFileUploadErrors, CreateFileUploadResponses, CreateGraphData, CreateGraphErrors, CreateGraphResponses, CreatePortalSessionData, CreatePortalSessionErrors, CreatePortalSessionResponses, CreateRepositorySubscriptionData, CreateRepositorySubscriptionErrors, CreateRepositorySubscriptionResponses, CreateUserApiKeyData, CreateUserApiKeyErrors, CreateUserApiKeyResponses, DeleteConnectionData, DeleteConnectionErrors, DeleteConnectionResponses, DeleteDocumentData, DeleteDocumentErrors, DeleteDocumentResponses, DeleteFileData, DeleteFileErrors, DeleteFileResponses, ExecuteCypherQueryData, ExecuteCypherQueryErrors, ExecuteCypherQueryResponses, ExecuteSpecificOperatorData, ExecuteSpecificOperatorErrors, ExecuteSpecificOperatorResponses, ExportGraphSchemaData, ExportGraphSchemaErrors, ExportGraphSchemaResponses, ForgotPasswordData, ForgotPasswordErrors, ForgotPasswordResponses, GenerateSsoTokenData, GenerateSsoTokenErrors, GenerateSsoTokenResponses, GetAvailableExtensionsData, GetAvailableExtensionsErrors, GetAvailableExtensionsResponses, GetAvailableGraphTiersData, GetAvailableGraphTiersErrors, GetAvailableGraphTiersResponses, GetBackupDownloadUrlData, GetBackupDownloadUrlErrors, GetBackupDownloadUrlResponses, GetBackupStatsData, GetBackupStatsErrors, GetBackupStatsResponses, GetCaptchaConfigData, GetCaptchaConfigErrors, GetCaptchaConfigResponses, GetCheckoutStatusData, GetCheckoutStatusErrors, GetCheckoutStatusResponses, GetConnectionData, GetConnectionErrors, GetConnectionOptionsData, GetConnectionOptionsErrors, GetConnectionOptionsResponses, GetConnectionResponses, GetCreditSummaryData, GetCreditSummaryErrors, GetCreditSummaryResponses, GetCurrentAuthUserData, GetCurrentAuthUserErrors, GetCurrentAuthUserResponses, GetCurrentUserData, GetCurrentUserErrors, GetCurrentUserResponses, GetDatabaseHealthData, GetDatabaseHealthErrors, GetDatabaseHealthResponses, GetDatabaseInfoData, GetDatabaseInfoErrors, GetDatabaseInfoResponses, GetDocumentData, GetDocumentErrors, GetDocumentResponses, GetDocumentSectionData, GetDocumentSectionErrors, GetDocumentSectionResponses, GetFileData, GetFileErrors, GetFileResponses, GetGraphCapacityData, GetGraphCapacityErrors, GetGraphCapacityResponses, GetGraphLimitsData, GetGraphLimitsErrors, GetGraphLimitsResponses, GetGraphMetricsData, GetGraphMetricsErrors, GetGraphMetricsResponses, GetGraphSchemaData, GetGraphSchemaErrors, GetGraphSchemaResponses, GetGraphsData, GetGraphsErrors, GetGraphsResponses, GetGraphSubscriptionData, GetGraphSubscriptionErrors, GetGraphSubscriptionResponses, GetGraphUsageAnalyticsData, GetGraphUsageAnalyticsErrors, GetGraphUsageAnalyticsResponses, GetOperationStatusData, GetOperationStatusErrors, GetOperationStatusResponses, GetOperatorMetadataData, GetOperatorMetadataErrors, GetOperatorMetadataResponses, GetOrgBillingCustomerData, GetOrgBillingCustomerErrors, GetOrgBillingCustomerResponses, GetOrgData, GetOrgErrors, GetOrgLimitsData, GetOrgLimitsErrors, GetOrgLimitsResponses, GetOrgResponses, GetOrgSubscriptionData, GetOrgSubscriptionErrors, GetOrgSubscriptionResponses, GetOrgUpcomingInvoiceData, GetOrgUpcomingInvoiceErrors, GetOrgUpcomingInvoiceResponses, GetOrgUsageData, GetOrgUsageErrors, GetOrgUsageResponses, GetPasswordPolicyData, GetPasswordPolicyErrors, GetPasswordPolicyResponses, GetServiceOfferingsData, GetServiceOfferingsErrors, GetServiceOfferingsResponses, GetServiceStatusData, GetServiceStatusResponses, GetSubgraphInfoData, GetSubgraphInfoErrors, GetSubgraphInfoResponses, GetSubgraphQuotaData, GetSubgraphQuotaErrors, GetSubgraphQuotaResponses, HandleHttpGetExtensionsGraphIdGraphqlGetData, HandleHttpGetExtensionsGraphIdGraphqlGetErrors, HandleHttpGetExtensionsGraphIdGraphqlGetResponses, HandleHttpPostExtensionsGraphIdGraphqlPostData, HandleHttpPostExtensionsGraphIdGraphqlPostErrors, HandleHttpPostExtensionsGraphIdGraphqlPostResponses, InitOAuthData, InitOAuthErrors, InitOAuthResponses, InviteOrgMemberData, InviteOrgMemberErrors, InviteOrgMemberResponses, ListBackupsData, ListBackupsErrors, ListBackupsResponses, ListConnectionsData, ListConnectionsErrors, ListConnectionsResponses, ListCreditTransactionsData, ListCreditTransactionsErrors, ListCreditTransactionsResponses, ListDocumentsData, ListDocumentsErrors, ListDocumentsResponses, ListFilesData, ListFilesErrors, ListFilesResponses, ListMcpToolsData, ListMcpToolsErrors, ListMcpToolsResponses, ListOperatorsData, ListOperatorsErrors, ListOperatorsResponses, ListOrgGraphsData, ListOrgGraphsErrors, ListOrgGraphsResponses, ListOrgInvoicesData, ListOrgInvoicesErrors, ListOrgInvoicesResponses, ListOrgMembersData, ListOrgMembersErrors, ListOrgMembersResponses, ListOrgSubscriptionsData, ListOrgSubscriptionsErrors, ListOrgSubscriptionsResponses, ListSubgraphsData, ListSubgraphsErrors, ListSubgraphsResponses, ListTablesData, ListTablesErrors, ListTablesResponses, ListUserApiKeysData, ListUserApiKeysErrors, ListUserApiKeysResponses, ListUserOrgsData, ListUserOrgsErrors, ListUserOrgsResponses, LoginUserData, LoginUserErrors, LoginUserResponses, LogoutUserData, LogoutUserErrors, LogoutUserResponses, OauthCallbackData, OauthCallbackErrors, OauthCallbackResponses, OpAddPublishListMembersData, OpAddPublishListMembersErrors, OpAddPublishListMembersResponses, OpAutoMapElementsData, OpAutoMapElementsErrors, OpAutoMapElementsResponses, OpBuildFactGridData, OpBuildFactGridErrors, OpBuildFactGridResponses, OpChangeReportingStyleData, OpChangeReportingStyleErrors, OpChangeReportingStyleResponses, OpChangeTierData, OpChangeTierErrors, OpChangeTierResponses, OpClosePeriodData, OpClosePeriodErrors, OpClosePeriodResponses, OpCreateAgentData, OpCreateAgentErrors, OpCreateAgentResponses, OpCreateBackupData, OpCreateBackupErrors, OpCreateBackupResponses, OpCreateEventBlockData, OpCreateEventBlockErrors, OpCreateEventBlockResponses, OpCreateEventHandlerData, OpCreateEventHandlerErrors, OpCreateEventHandlerResponses, OpCreateInformationBlockData, OpCreateInformationBlockErrors, OpCreateInformationBlockResponses, OpCreateMappingAssociationData, OpCreateMappingAssociationErrors, OpCreateMappingAssociationResponses, OpCreatePortfolioBlockData, OpCreatePortfolioBlockErrors, OpCreatePortfolioBlockResponses, OpCreatePublishListData, OpCreatePublishListErrors, OpCreatePublishListResponses, OpCreateReportData, OpCreateReportErrors, OpCreateReportResponses, OpCreateSecurityData, OpCreateSecurityErrors, OpCreateSecurityResponses, OpCreateSubgraphData, OpCreateSubgraphErrors, OpCreateSubgraphResponses, OpCreateTaxonomyBlockData, OpCreateTaxonomyBlockErrors, OpCreateTaxonomyBlockResponses, OpDeleteGraphData, OpDeleteGraphErrors, OpDeleteGraphResponses, OpDeleteInformationBlockData, OpDeleteInformationBlockErrors, OpDeleteInformationBlockResponses, OpDeleteJournalEntryData, OpDeleteJournalEntryErrors, OpDeleteJournalEntryResponses, OpDeleteMappingAssociationData, OpDeleteMappingAssociationErrors, OpDeleteMappingAssociationResponses, OpDeletePortfolioBlockData, OpDeletePortfolioBlockErrors, OpDeletePortfolioBlockResponses, OpDeletePublishListData, OpDeletePublishListErrors, OpDeletePublishListResponses, OpDeleteReportData, OpDeleteReportErrors, OpDeleteReportResponses, OpDeleteSecurityData, OpDeleteSecurityErrors, OpDeleteSecurityResponses, OpDeleteSubgraphData, OpDeleteSubgraphErrors, OpDeleteSubgraphResponses, OpDeleteTaxonomyBlockData, OpDeleteTaxonomyBlockErrors, OpDeleteTaxonomyBlockResponses, OpEvaluateRulesData, OpEvaluateRulesErrors, OpEvaluateRulesResponses, OpExecuteEventBlockData, OpExecuteEventBlockErrors, OpExecuteEventBlockResponses, OpFileReportData, OpFileReportErrors, OpFileReportResponses, OpFinancialStatementAnalysisData, OpFinancialStatementAnalysisErrors, OpFinancialStatementAnalysisResponses, OpInitializeLedgerData, OpInitializeLedgerErrors, OpInitializeLedgerResponses, OpLinkEntityTaxonomyData, OpLinkEntityTaxonomyErrors, OpLinkEntityTaxonomyResponses, OpLiveFinancialStatementData, OpLiveFinancialStatementErrors, OpLiveFinancialStatementResponses, OpMaterializeData, OpMaterializeErrors, OpMaterializeResponses, OpPreviewEventBlockData, OpPreviewEventBlockErrors, OpPreviewEventBlockResponses, OpRegenerateReportData, OpRegenerateReportErrors, OpRegenerateReportResponses, OpRemovePublishListMemberData, OpRemovePublishListMemberErrors, OpRemovePublishListMemberResponses, OpReopenPeriodData, OpReopenPeriodErrors, OpReopenPeriodResponses, OpRestoreBackupData, OpRestoreBackupErrors, OpRestoreBackupResponses, OpSetCloseTargetData, OpSetCloseTargetErrors, OpSetCloseTargetResponses, OpShareReportData, OpShareReportErrors, OpShareReportResponses, OpTransitionFilingStatusData, OpTransitionFilingStatusErrors, OpTransitionFilingStatusResponses, OpUpdateAgentData, OpUpdateAgentErrors, OpUpdateAgentResponses, OpUpdateEntityData, OpUpdateEntityErrors, OpUpdateEntityResponses, OpUpdateEventBlockData, OpUpdateEventBlockErrors, OpUpdateEventBlockResponses, OpUpdateEventHandlerData, OpUpdateEventHandlerErrors, OpUpdateEventHandlerResponses, OpUpdateInformationBlockData, OpUpdateInformationBlockErrors, OpUpdateInformationBlockResponses, OpUpdateJournalEntryData, OpUpdateJournalEntryErrors, OpUpdateJournalEntryResponses, OpUpdatePortfolioBlockData, OpUpdatePortfolioBlockErrors, OpUpdatePortfolioBlockResponses, OpUpdatePublishListData, OpUpdatePublishListErrors, OpUpdatePublishListResponses, OpUpdateSecurityData, OpUpdateSecurityErrors, OpUpdateSecurityResponses, OpUpdateTaxonomyBlockData, OpUpdateTaxonomyBlockErrors, OpUpdateTaxonomyBlockResponses, QueryTablesData, QueryTablesErrors, QueryTablesResponses, RecommendOperatorData, RecommendOperatorErrors, RecommendOperatorResponses, RefreshAuthSessionData, RefreshAuthSessionErrors, RefreshAuthSessionResponses, RegisterUserData, RegisterUserErrors, RegisterUserResponses, RemoveOrgMemberData, RemoveOrgMemberErrors, RemoveOrgMemberResponses, ResendVerificationEmailData, ResendVerificationEmailErrors, ResendVerificationEmailResponses, ResetPasswordData, ResetPasswordErrors, ResetPasswordResponses, RevokeUserApiKeyData, RevokeUserApiKeyErrors, RevokeUserApiKeyResponses, SearchDocumentsData, SearchDocumentsErrors, SearchDocumentsResponses, SelectGraphData, SelectGraphErrors, SelectGraphResponses, SsoTokenExchangeData, SsoTokenExchangeErrors, SsoTokenExchangeResponses, StreamOperationEventsData, StreamOperationEventsErrors, StreamOperationEventsResponses, SyncConnectionData, SyncConnectionErrors, SyncConnectionResponses, UpdateDocumentData, UpdateDocumentErrors, UpdateDocumentResponses, UpdateFileData, UpdateFileErrors, UpdateFileResponses, UpdateOrgData, UpdateOrgErrors, UpdateOrgMemberRoleData, UpdateOrgMemberRoleErrors, UpdateOrgMemberRoleResponses, UpdateOrgResponses, UpdateUserApiKeyData, UpdateUserApiKeyErrors, UpdateUserApiKeyResponses, UpdateUserData, UpdateUserErrors, UpdateUserPasswordData, UpdateUserPasswordErrors, UpdateUserPasswordResponses, UpdateUserResponses, UploadDocumentData, UploadDocumentErrors, UploadDocumentResponses, ValidateResetTokenData, ValidateResetTokenErrors, ValidateResetTokenResponses, ValidateSchemaData, ValidateSchemaErrors, ValidateSchemaResponses, VerifyEmailData, VerifyEmailErrors, VerifyEmailResponses } from './types.gen';
|
|
5
|
+
import type { AutoSelectOperatorData, AutoSelectOperatorErrors, AutoSelectOperatorResponses, BatchProcessQueriesData, BatchProcessQueriesErrors, BatchProcessQueriesResponses, CallMcpToolData, CallMcpToolErrors, CallMcpToolResponses, CancelOperationData, CancelOperationErrors, CancelOperationResponses, CancelOrgSubscriptionData, CancelOrgSubscriptionErrors, CancelOrgSubscriptionResponses, CancelRepositorySubscriptionData, CancelRepositorySubscriptionErrors, CancelRepositorySubscriptionResponses, ChangeSubscriptionPlanData, ChangeSubscriptionPlanErrors, ChangeSubscriptionPlanResponses, CheckPasswordStrengthData, CheckPasswordStrengthErrors, CheckPasswordStrengthResponses, CompleteSsoAuthData, CompleteSsoAuthErrors, CompleteSsoAuthResponses, CreateCheckoutSessionData, CreateCheckoutSessionErrors, CreateCheckoutSessionResponses, CreateConnectionData, CreateConnectionErrors, CreateConnectionResponses, CreateFileUploadData, CreateFileUploadErrors, CreateFileUploadResponses, CreateGraphData, CreateGraphErrors, CreateGraphResponses, CreatePortalSessionData, CreatePortalSessionErrors, CreatePortalSessionResponses, CreateRepositorySubscriptionData, CreateRepositorySubscriptionErrors, CreateRepositorySubscriptionResponses, CreateUserApiKeyData, CreateUserApiKeyErrors, CreateUserApiKeyResponses, DeleteConnectionData, DeleteConnectionErrors, DeleteConnectionResponses, DeleteDocumentData, DeleteDocumentErrors, DeleteDocumentResponses, DeleteFileData, DeleteFileErrors, DeleteFileResponses, ExecuteCypherQueryData, ExecuteCypherQueryErrors, ExecuteCypherQueryResponses, ExecuteSpecificOperatorData, ExecuteSpecificOperatorErrors, ExecuteSpecificOperatorResponses, ExportGraphSchemaData, ExportGraphSchemaErrors, ExportGraphSchemaResponses, ForgotPasswordData, ForgotPasswordErrors, ForgotPasswordResponses, GenerateSsoTokenData, GenerateSsoTokenErrors, GenerateSsoTokenResponses, GetAvailableExtensionsData, GetAvailableExtensionsErrors, GetAvailableExtensionsResponses, GetAvailableGraphTiersData, GetAvailableGraphTiersErrors, GetAvailableGraphTiersResponses, GetBackupDownloadUrlData, GetBackupDownloadUrlErrors, GetBackupDownloadUrlResponses, GetBackupStatsData, GetBackupStatsErrors, GetBackupStatsResponses, GetCaptchaConfigData, GetCaptchaConfigErrors, GetCaptchaConfigResponses, GetCheckoutStatusData, GetCheckoutStatusErrors, GetCheckoutStatusResponses, GetConnectionData, GetConnectionErrors, GetConnectionOptionsData, GetConnectionOptionsErrors, GetConnectionOptionsResponses, GetConnectionResponses, GetCreditSummaryData, GetCreditSummaryErrors, GetCreditSummaryResponses, GetCurrentAuthUserData, GetCurrentAuthUserErrors, GetCurrentAuthUserResponses, GetCurrentUserData, GetCurrentUserErrors, GetCurrentUserResponses, GetDatabaseHealthData, GetDatabaseHealthErrors, GetDatabaseHealthResponses, GetDatabaseInfoData, GetDatabaseInfoErrors, GetDatabaseInfoResponses, GetDocumentData, GetDocumentErrors, GetDocumentResponses, GetDocumentSectionData, GetDocumentSectionErrors, GetDocumentSectionResponses, GetFileData, GetFileErrors, GetFileResponses, GetGraphCapacityData, GetGraphCapacityErrors, GetGraphCapacityResponses, GetGraphLimitsData, GetGraphLimitsErrors, GetGraphLimitsResponses, GetGraphMetricsData, GetGraphMetricsErrors, GetGraphMetricsResponses, GetGraphSchemaData, GetGraphSchemaErrors, GetGraphSchemaResponses, GetGraphsData, GetGraphsErrors, GetGraphsResponses, GetGraphSubscriptionData, GetGraphSubscriptionErrors, GetGraphSubscriptionResponses, GetGraphUsageAnalyticsData, GetGraphUsageAnalyticsErrors, GetGraphUsageAnalyticsResponses, GetOperationStatusData, GetOperationStatusErrors, GetOperationStatusResponses, GetOperatorMetadataData, GetOperatorMetadataErrors, GetOperatorMetadataResponses, GetOrgBillingCustomerData, GetOrgBillingCustomerErrors, GetOrgBillingCustomerResponses, GetOrgData, GetOrgErrors, GetOrgLimitsData, GetOrgLimitsErrors, GetOrgLimitsResponses, GetOrgResponses, GetOrgSubscriptionData, GetOrgSubscriptionErrors, GetOrgSubscriptionResponses, GetOrgUpcomingInvoiceData, GetOrgUpcomingInvoiceErrors, GetOrgUpcomingInvoiceResponses, GetOrgUsageData, GetOrgUsageErrors, GetOrgUsageResponses, GetPasswordPolicyData, GetPasswordPolicyErrors, GetPasswordPolicyResponses, GetReportBundleDownloadUrlData, GetReportBundleDownloadUrlErrors, GetReportBundleDownloadUrlResponses, GetServiceOfferingsData, GetServiceOfferingsErrors, GetServiceOfferingsResponses, GetServiceStatusData, GetServiceStatusResponses, GetSubgraphInfoData, GetSubgraphInfoErrors, GetSubgraphInfoResponses, GetSubgraphQuotaData, GetSubgraphQuotaErrors, GetSubgraphQuotaResponses, HandleHttpGetExtensionsGraphIdGraphqlGetData, HandleHttpGetExtensionsGraphIdGraphqlGetErrors, HandleHttpGetExtensionsGraphIdGraphqlGetResponses, HandleHttpPostExtensionsGraphIdGraphqlPostData, HandleHttpPostExtensionsGraphIdGraphqlPostErrors, HandleHttpPostExtensionsGraphIdGraphqlPostResponses, InitOAuthData, InitOAuthErrors, InitOAuthResponses, InviteOrgMemberData, InviteOrgMemberErrors, InviteOrgMemberResponses, ListBackupsData, ListBackupsErrors, ListBackupsResponses, ListConnectionsData, ListConnectionsErrors, ListConnectionsResponses, ListCreditTransactionsData, ListCreditTransactionsErrors, ListCreditTransactionsResponses, ListDocumentsData, ListDocumentsErrors, ListDocumentsResponses, ListFilesData, ListFilesErrors, ListFilesResponses, ListMcpToolsData, ListMcpToolsErrors, ListMcpToolsResponses, ListOperatorsData, ListOperatorsErrors, ListOperatorsResponses, ListOrgGraphsData, ListOrgGraphsErrors, ListOrgGraphsResponses, ListOrgInvoicesData, ListOrgInvoicesErrors, ListOrgInvoicesResponses, ListOrgMembersData, ListOrgMembersErrors, ListOrgMembersResponses, ListOrgSubscriptionsData, ListOrgSubscriptionsErrors, ListOrgSubscriptionsResponses, ListSubgraphsData, ListSubgraphsErrors, ListSubgraphsResponses, ListTablesData, ListTablesErrors, ListTablesResponses, ListUserApiKeysData, ListUserApiKeysErrors, ListUserApiKeysResponses, ListUserOrgsData, ListUserOrgsErrors, ListUserOrgsResponses, LoginUserData, LoginUserErrors, LoginUserResponses, LogoutUserData, LogoutUserErrors, LogoutUserResponses, OauthCallbackData, OauthCallbackErrors, OauthCallbackResponses, OpAddPublishListMembersData, OpAddPublishListMembersErrors, OpAddPublishListMembersResponses, OpAutoMapElementsData, OpAutoMapElementsErrors, OpAutoMapElementsResponses, OpBuildFactGridData, OpBuildFactGridErrors, OpBuildFactGridResponses, OpChangeReportingStyleData, OpChangeReportingStyleErrors, OpChangeReportingStyleResponses, OpChangeTierData, OpChangeTierErrors, OpChangeTierResponses, OpClosePeriodData, OpClosePeriodErrors, OpClosePeriodResponses, OpCreateAgentData, OpCreateAgentErrors, OpCreateAgentResponses, OpCreateBackupData, OpCreateBackupErrors, OpCreateBackupResponses, OpCreateEventBlockData, OpCreateEventBlockErrors, OpCreateEventBlockResponses, OpCreateEventHandlerData, OpCreateEventHandlerErrors, OpCreateEventHandlerResponses, OpCreateInformationBlockData, OpCreateInformationBlockErrors, OpCreateInformationBlockResponses, OpCreateMappingAssociationData, OpCreateMappingAssociationErrors, OpCreateMappingAssociationResponses, OpCreatePortfolioBlockData, OpCreatePortfolioBlockErrors, OpCreatePortfolioBlockResponses, OpCreatePublishListData, OpCreatePublishListErrors, OpCreatePublishListResponses, OpCreateReportData, OpCreateReportErrors, OpCreateReportResponses, OpCreateSecurityData, OpCreateSecurityErrors, OpCreateSecurityResponses, OpCreateSubgraphData, OpCreateSubgraphErrors, OpCreateSubgraphResponses, OpCreateTaxonomyBlockData, OpCreateTaxonomyBlockErrors, OpCreateTaxonomyBlockResponses, OpDeleteGraphData, OpDeleteGraphErrors, OpDeleteGraphResponses, OpDeleteInformationBlockData, OpDeleteInformationBlockErrors, OpDeleteInformationBlockResponses, OpDeleteJournalEntryData, OpDeleteJournalEntryErrors, OpDeleteJournalEntryResponses, OpDeleteMappingAssociationData, OpDeleteMappingAssociationErrors, OpDeleteMappingAssociationResponses, OpDeletePortfolioBlockData, OpDeletePortfolioBlockErrors, OpDeletePortfolioBlockResponses, OpDeletePublishListData, OpDeletePublishListErrors, OpDeletePublishListResponses, OpDeleteReportData, OpDeleteReportErrors, OpDeleteReportResponses, OpDeleteSecurityData, OpDeleteSecurityErrors, OpDeleteSecurityResponses, OpDeleteSubgraphData, OpDeleteSubgraphErrors, OpDeleteSubgraphResponses, OpDeleteTaxonomyBlockData, OpDeleteTaxonomyBlockErrors, OpDeleteTaxonomyBlockResponses, OpEvaluateRulesData, OpEvaluateRulesErrors, OpEvaluateRulesResponses, OpExecuteEventBlockData, OpExecuteEventBlockErrors, OpExecuteEventBlockResponses, OpFileReportData, OpFileReportErrors, OpFileReportResponses, OpFinancialStatementAnalysisData, OpFinancialStatementAnalysisErrors, OpFinancialStatementAnalysisResponses, OpInitializeLedgerData, OpInitializeLedgerErrors, OpInitializeLedgerResponses, OpLinkEntityTaxonomyData, OpLinkEntityTaxonomyErrors, OpLinkEntityTaxonomyResponses, OpLiveFinancialStatementData, OpLiveFinancialStatementErrors, OpLiveFinancialStatementResponses, OpMaterializeData, OpMaterializeErrors, OpMaterializeResponses, OpPreviewEventBlockData, OpPreviewEventBlockErrors, OpPreviewEventBlockResponses, OpRegenerateReportData, OpRegenerateReportErrors, OpRegenerateReportResponses, OpRemovePublishListMemberData, OpRemovePublishListMemberErrors, OpRemovePublishListMemberResponses, OpReopenPeriodData, OpReopenPeriodErrors, OpReopenPeriodResponses, OpRestoreBackupData, OpRestoreBackupErrors, OpRestoreBackupResponses, OpSetCloseTargetData, OpSetCloseTargetErrors, OpSetCloseTargetResponses, OpShareReportData, OpShareReportErrors, OpShareReportResponses, OpTransitionFilingStatusData, OpTransitionFilingStatusErrors, OpTransitionFilingStatusResponses, OpUpdateAgentData, OpUpdateAgentErrors, OpUpdateAgentResponses, OpUpdateEntityData, OpUpdateEntityErrors, OpUpdateEntityResponses, OpUpdateEventBlockData, OpUpdateEventBlockErrors, OpUpdateEventBlockResponses, OpUpdateEventHandlerData, OpUpdateEventHandlerErrors, OpUpdateEventHandlerResponses, OpUpdateInformationBlockData, OpUpdateInformationBlockErrors, OpUpdateInformationBlockResponses, OpUpdateJournalEntryData, OpUpdateJournalEntryErrors, OpUpdateJournalEntryResponses, OpUpdatePortfolioBlockData, OpUpdatePortfolioBlockErrors, OpUpdatePortfolioBlockResponses, OpUpdatePublishListData, OpUpdatePublishListErrors, OpUpdatePublishListResponses, OpUpdateSecurityData, OpUpdateSecurityErrors, OpUpdateSecurityResponses, OpUpdateTaxonomyBlockData, OpUpdateTaxonomyBlockErrors, OpUpdateTaxonomyBlockResponses, QueryTablesData, QueryTablesErrors, QueryTablesResponses, RecommendOperatorData, RecommendOperatorErrors, RecommendOperatorResponses, RefreshAuthSessionData, RefreshAuthSessionErrors, RefreshAuthSessionResponses, RegisterUserData, RegisterUserErrors, RegisterUserResponses, RemoveOrgMemberData, RemoveOrgMemberErrors, RemoveOrgMemberResponses, ResendVerificationEmailData, ResendVerificationEmailErrors, ResendVerificationEmailResponses, ResetPasswordData, ResetPasswordErrors, ResetPasswordResponses, RevokeUserApiKeyData, RevokeUserApiKeyErrors, RevokeUserApiKeyResponses, SearchDocumentsData, SearchDocumentsErrors, SearchDocumentsResponses, SelectGraphData, SelectGraphErrors, SelectGraphResponses, SsoTokenExchangeData, SsoTokenExchangeErrors, SsoTokenExchangeResponses, StreamOperationEventsData, StreamOperationEventsErrors, StreamOperationEventsResponses, SyncConnectionData, SyncConnectionErrors, SyncConnectionResponses, UpdateDocumentData, UpdateDocumentErrors, UpdateDocumentResponses, UpdateFileData, UpdateFileErrors, UpdateFileResponses, UpdateOrgData, UpdateOrgErrors, UpdateOrgMemberRoleData, UpdateOrgMemberRoleErrors, UpdateOrgMemberRoleResponses, UpdateOrgResponses, UpdateUserApiKeyData, UpdateUserApiKeyErrors, UpdateUserApiKeyResponses, UpdateUserData, UpdateUserErrors, UpdateUserPasswordData, UpdateUserPasswordErrors, UpdateUserPasswordResponses, UpdateUserResponses, UploadDocumentData, UploadDocumentErrors, UploadDocumentResponses, ValidateResetTokenData, ValidateResetTokenErrors, ValidateResetTokenResponses, ValidateSchemaData, ValidateSchemaErrors, ValidateSchemaResponses, VerifyEmailData, VerifyEmailErrors, VerifyEmailResponses } from './types.gen';
|
|
6
6
|
|
|
7
7
|
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
|
|
8
8
|
/**
|
|
@@ -2008,6 +2008,17 @@ export const opLiveFinancialStatement = <ThrowOnError extends boolean = false>(o
|
|
|
2008
2008
|
}
|
|
2009
2009
|
});
|
|
2010
2010
|
|
|
2011
|
+
/**
|
|
2012
|
+
* Download Report bundle
|
|
2013
|
+
*
|
|
2014
|
+
* Return the published Report's serialization bundle. ``format=jsonld`` (default) returns a JSON envelope containing a short-lived presigned URL to the stamped JSON-LD bundle in S3. ``format=xbrl-2.1`` rebuilds the bundle on-demand and streams an XBRL 2.1 zip directly. 404 when the Report has no stamped bundle (published before the serialization feature shipped — JSON-LD only).
|
|
2015
|
+
*/
|
|
2016
|
+
export const getReportBundleDownloadUrl = <ThrowOnError extends boolean = false>(options: Options<GetReportBundleDownloadUrlData, ThrowOnError>) => (options.client ?? client).get<GetReportBundleDownloadUrlResponses, GetReportBundleDownloadUrlErrors, ThrowOnError>({
|
|
2017
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2018
|
+
url: '/extensions/roboledger/{graph_id}/reports/{report_id}/download',
|
|
2019
|
+
...options
|
|
2020
|
+
});
|
|
2021
|
+
|
|
2011
2022
|
/**
|
|
2012
2023
|
* Build Fact Grid
|
|
2013
2024
|
*
|
package/types.gen.d.ts
CHANGED
|
@@ -21458,6 +21458,90 @@ export type OpLiveFinancialStatementResponses = {
|
|
|
21458
21458
|
200: OperationEnvelope;
|
|
21459
21459
|
};
|
|
21460
21460
|
export type OpLiveFinancialStatementResponse = OpLiveFinancialStatementResponses[keyof OpLiveFinancialStatementResponses];
|
|
21461
|
+
export type GetReportBundleDownloadUrlData = {
|
|
21462
|
+
body?: never;
|
|
21463
|
+
path: {
|
|
21464
|
+
/**
|
|
21465
|
+
* Graph Id
|
|
21466
|
+
*/
|
|
21467
|
+
graph_id: string;
|
|
21468
|
+
/**
|
|
21469
|
+
* Report Id
|
|
21470
|
+
*
|
|
21471
|
+
* Report identifier (rpt_-prefixed ULID).
|
|
21472
|
+
*/
|
|
21473
|
+
report_id: string;
|
|
21474
|
+
};
|
|
21475
|
+
query?: {
|
|
21476
|
+
/**
|
|
21477
|
+
* Format
|
|
21478
|
+
*
|
|
21479
|
+
* Serialization flavor. ``jsonld`` returns a presigned URL to the stored JSON-LD bundle; ``xbrl-2.1`` streams a freshly-emitted XBRL zip directly. Other RDF / XBRL flavors slot in as their producers ship.
|
|
21480
|
+
*/
|
|
21481
|
+
format?: string;
|
|
21482
|
+
/**
|
|
21483
|
+
* Expires In
|
|
21484
|
+
*
|
|
21485
|
+
* Presigned URL lifetime in seconds (min 60, max 3600). Ignored for XBRL flavors (streamed directly, no URL).
|
|
21486
|
+
*/
|
|
21487
|
+
expires_in?: number;
|
|
21488
|
+
};
|
|
21489
|
+
url: '/extensions/roboledger/{graph_id}/reports/{report_id}/download';
|
|
21490
|
+
};
|
|
21491
|
+
export type GetReportBundleDownloadUrlErrors = {
|
|
21492
|
+
/**
|
|
21493
|
+
* Validation Error
|
|
21494
|
+
*/
|
|
21495
|
+
422: HttpValidationError;
|
|
21496
|
+
};
|
|
21497
|
+
export type GetReportBundleDownloadUrlError = GetReportBundleDownloadUrlErrors[keyof GetReportBundleDownloadUrlErrors];
|
|
21498
|
+
export type GetReportBundleDownloadUrlResponses = {
|
|
21499
|
+
/**
|
|
21500
|
+
* ReportBundleDownloadResponse
|
|
21501
|
+
*
|
|
21502
|
+
* Presigned-URL response for a Report bundle download.
|
|
21503
|
+
*
|
|
21504
|
+
* Mirrors :class:`BackupDownloadUrlResponse` in shape — the frontend
|
|
21505
|
+
* treats both the same way (fetch, follow URL, GET the artifact).
|
|
21506
|
+
*
|
|
21507
|
+
* Only returned for RDF-family flavors (JSON-LD) where the artifact
|
|
21508
|
+
* is stored in S3. XBRL flavors stream the binary content directly
|
|
21509
|
+
* in the response body (no JSON wrapper).
|
|
21510
|
+
*/
|
|
21511
|
+
200: {
|
|
21512
|
+
/**
|
|
21513
|
+
* Download Url
|
|
21514
|
+
*
|
|
21515
|
+
* Presigned URL that streams the bundle directly from S3.
|
|
21516
|
+
*/
|
|
21517
|
+
download_url: string;
|
|
21518
|
+
/**
|
|
21519
|
+
* Expires At
|
|
21520
|
+
*
|
|
21521
|
+
* UTC timestamp at which the presigned URL stops working.
|
|
21522
|
+
*/
|
|
21523
|
+
expires_at: string;
|
|
21524
|
+
/**
|
|
21525
|
+
* Content Type
|
|
21526
|
+
*
|
|
21527
|
+
* MIME type of the artifact behind the URL.
|
|
21528
|
+
*/
|
|
21529
|
+
content_type: string;
|
|
21530
|
+
/**
|
|
21531
|
+
* Format
|
|
21532
|
+
*
|
|
21533
|
+
* Serialization flavor delivered by this URL — matches the ``format`` query parameter.
|
|
21534
|
+
*/
|
|
21535
|
+
format: string;
|
|
21536
|
+
/**
|
|
21537
|
+
* Generation Count
|
|
21538
|
+
*
|
|
21539
|
+
* Bundle generation number stamped on the Report.
|
|
21540
|
+
*/
|
|
21541
|
+
generation_count: number;
|
|
21542
|
+
};
|
|
21543
|
+
};
|
|
21544
|
+
export type GetReportBundleDownloadUrlResponse = GetReportBundleDownloadUrlResponses[keyof GetReportBundleDownloadUrlResponses];
|
|
21461
21545
|
export type OpBuildFactGridData = {
|
|
21462
21546
|
body: CreateViewRequest;
|
|
21463
21547
|
headers?: {
|
package/types.gen.ts
CHANGED
|
@@ -22555,6 +22555,95 @@ export type OpLiveFinancialStatementResponses = {
|
|
|
22555
22555
|
|
|
22556
22556
|
export type OpLiveFinancialStatementResponse = OpLiveFinancialStatementResponses[keyof OpLiveFinancialStatementResponses];
|
|
22557
22557
|
|
|
22558
|
+
export type GetReportBundleDownloadUrlData = {
|
|
22559
|
+
body?: never;
|
|
22560
|
+
path: {
|
|
22561
|
+
/**
|
|
22562
|
+
* Graph Id
|
|
22563
|
+
*/
|
|
22564
|
+
graph_id: string;
|
|
22565
|
+
/**
|
|
22566
|
+
* Report Id
|
|
22567
|
+
*
|
|
22568
|
+
* Report identifier (rpt_-prefixed ULID).
|
|
22569
|
+
*/
|
|
22570
|
+
report_id: string;
|
|
22571
|
+
};
|
|
22572
|
+
query?: {
|
|
22573
|
+
/**
|
|
22574
|
+
* Format
|
|
22575
|
+
*
|
|
22576
|
+
* Serialization flavor. ``jsonld`` returns a presigned URL to the stored JSON-LD bundle; ``xbrl-2.1`` streams a freshly-emitted XBRL zip directly. Other RDF / XBRL flavors slot in as their producers ship.
|
|
22577
|
+
*/
|
|
22578
|
+
format?: string;
|
|
22579
|
+
/**
|
|
22580
|
+
* Expires In
|
|
22581
|
+
*
|
|
22582
|
+
* Presigned URL lifetime in seconds (min 60, max 3600). Ignored for XBRL flavors (streamed directly, no URL).
|
|
22583
|
+
*/
|
|
22584
|
+
expires_in?: number;
|
|
22585
|
+
};
|
|
22586
|
+
url: '/extensions/roboledger/{graph_id}/reports/{report_id}/download';
|
|
22587
|
+
};
|
|
22588
|
+
|
|
22589
|
+
export type GetReportBundleDownloadUrlErrors = {
|
|
22590
|
+
/**
|
|
22591
|
+
* Validation Error
|
|
22592
|
+
*/
|
|
22593
|
+
422: HttpValidationError;
|
|
22594
|
+
};
|
|
22595
|
+
|
|
22596
|
+
export type GetReportBundleDownloadUrlError = GetReportBundleDownloadUrlErrors[keyof GetReportBundleDownloadUrlErrors];
|
|
22597
|
+
|
|
22598
|
+
export type GetReportBundleDownloadUrlResponses = {
|
|
22599
|
+
/**
|
|
22600
|
+
* ReportBundleDownloadResponse
|
|
22601
|
+
*
|
|
22602
|
+
* Presigned-URL response for a Report bundle download.
|
|
22603
|
+
*
|
|
22604
|
+
* Mirrors :class:`BackupDownloadUrlResponse` in shape — the frontend
|
|
22605
|
+
* treats both the same way (fetch, follow URL, GET the artifact).
|
|
22606
|
+
*
|
|
22607
|
+
* Only returned for RDF-family flavors (JSON-LD) where the artifact
|
|
22608
|
+
* is stored in S3. XBRL flavors stream the binary content directly
|
|
22609
|
+
* in the response body (no JSON wrapper).
|
|
22610
|
+
*/
|
|
22611
|
+
200: {
|
|
22612
|
+
/**
|
|
22613
|
+
* Download Url
|
|
22614
|
+
*
|
|
22615
|
+
* Presigned URL that streams the bundle directly from S3.
|
|
22616
|
+
*/
|
|
22617
|
+
download_url: string;
|
|
22618
|
+
/**
|
|
22619
|
+
* Expires At
|
|
22620
|
+
*
|
|
22621
|
+
* UTC timestamp at which the presigned URL stops working.
|
|
22622
|
+
*/
|
|
22623
|
+
expires_at: string;
|
|
22624
|
+
/**
|
|
22625
|
+
* Content Type
|
|
22626
|
+
*
|
|
22627
|
+
* MIME type of the artifact behind the URL.
|
|
22628
|
+
*/
|
|
22629
|
+
content_type: string;
|
|
22630
|
+
/**
|
|
22631
|
+
* Format
|
|
22632
|
+
*
|
|
22633
|
+
* Serialization flavor delivered by this URL — matches the ``format`` query parameter.
|
|
22634
|
+
*/
|
|
22635
|
+
format: string;
|
|
22636
|
+
/**
|
|
22637
|
+
* Generation Count
|
|
22638
|
+
*
|
|
22639
|
+
* Bundle generation number stamped on the Report.
|
|
22640
|
+
*/
|
|
22641
|
+
generation_count: number;
|
|
22642
|
+
};
|
|
22643
|
+
};
|
|
22644
|
+
|
|
22645
|
+
export type GetReportBundleDownloadUrlResponse = GetReportBundleDownloadUrlResponses[keyof GetReportBundleDownloadUrlResponses];
|
|
22646
|
+
|
|
22558
22647
|
export type OpBuildFactGridData = {
|
|
22559
22648
|
body: CreateViewRequest;
|
|
22560
22649
|
headers?: {
|