@robosystems/client 0.3.1 → 0.3.2
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/{extensions → artifacts}/InvestorClient.js +0 -1
- package/{extensions → artifacts}/InvestorClient.ts +1 -1
- package/{extensions → artifacts}/LedgerClient.d.ts +168 -2
- package/{extensions → artifacts}/LedgerClient.js +301 -2
- package/{extensions → artifacts}/LedgerClient.ts +645 -2
- package/{extensions → artifacts}/config.d.ts +11 -11
- package/{extensions → artifacts}/config.js +11 -11
- package/{extensions → artifacts}/config.ts +16 -16
- package/{extensions → artifacts}/graphql/client.d.ts +1 -1
- package/{extensions → artifacts}/graphql/client.js +1 -2
- package/{extensions → artifacts}/graphql/client.ts +2 -2
- package/{extensions → artifacts}/hooks.js +6 -6
- package/{extensions → artifacts}/hooks.ts +7 -7
- package/{extensions → artifacts}/index.d.ts +21 -18
- package/{extensions → artifacts}/index.js +43 -53
- package/{extensions → artifacts}/index.ts +47 -60
- package/index.d.ts +2 -2
- package/index.js +2 -2
- package/index.ts +2 -2
- package/package.json +38 -8
- package/sdk/index.d.ts +2 -2
- package/sdk/index.js +27 -9
- package/sdk/index.ts +2 -2
- package/sdk/sdk.gen.d.ts +275 -274
- package/sdk/sdk.gen.js +469 -314
- package/sdk/sdk.gen.ts +465 -311
- package/sdk/types.gen.d.ts +2940 -466
- package/sdk/types.gen.ts +3053 -474
- package/sdk.gen.d.ts +275 -274
- package/sdk.gen.js +469 -314
- package/sdk.gen.ts +465 -311
- package/types.gen.d.ts +2940 -466
- package/types.gen.ts +3053 -474
- package/extensions/ReportClient.d.ts +0 -120
- package/extensions/ReportClient.js +0 -191
- package/extensions/ReportClient.ts +0 -433
- /package/{extensions → artifacts}/AgentClient.d.ts +0 -0
- /package/{extensions → artifacts}/AgentClient.js +0 -0
- /package/{extensions → artifacts}/AgentClient.ts +0 -0
- /package/{extensions → artifacts}/InvestorClient.d.ts +0 -0
- /package/{extensions → artifacts}/OperationClient.d.ts +0 -0
- /package/{extensions → artifacts}/OperationClient.js +0 -0
- /package/{extensions → artifacts}/OperationClient.ts +0 -0
- /package/{extensions → artifacts}/QueryClient.d.ts +0 -0
- /package/{extensions → artifacts}/QueryClient.js +0 -0
- /package/{extensions → artifacts}/QueryClient.ts +0 -0
- /package/{extensions → artifacts}/SSEClient.d.ts +0 -0
- /package/{extensions → artifacts}/SSEClient.js +0 -0
- /package/{extensions → artifacts}/SSEClient.ts +0 -0
- /package/{extensions → artifacts}/graphql/generated/graphql.d.ts +0 -0
- /package/{extensions → artifacts}/graphql/generated/graphql.js +0 -0
- /package/{extensions → artifacts}/graphql/generated/graphql.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/investor/holdings.d.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/investor/holdings.js +0 -0
- /package/{extensions → artifacts}/graphql/queries/investor/holdings.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/investor/portfolio.d.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/investor/portfolio.js +0 -0
- /package/{extensions → artifacts}/graphql/queries/investor/portfolio.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/investor/portfolios.d.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/investor/portfolios.js +0 -0
- /package/{extensions → artifacts}/graphql/queries/investor/portfolios.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/investor/position.d.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/investor/position.js +0 -0
- /package/{extensions → artifacts}/graphql/queries/investor/position.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/investor/positions.d.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/investor/positions.js +0 -0
- /package/{extensions → artifacts}/graphql/queries/investor/positions.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/investor/securities.d.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/investor/securities.js +0 -0
- /package/{extensions → artifacts}/graphql/queries/investor/securities.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/investor/security.d.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/investor/security.js +0 -0
- /package/{extensions → artifacts}/graphql/queries/investor/security.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/accountRollups.d.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/accountRollups.js +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/accountRollups.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/accountTree.d.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/accountTree.js +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/accountTree.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/accounts.d.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/accounts.js +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/accounts.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/closingBookStructures.d.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/closingBookStructures.js +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/closingBookStructures.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/elements.d.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/elements.js +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/elements.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/entities.d.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/entities.js +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/entities.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/entity.d.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/entity.js +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/entity.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/fiscalCalendar.d.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/fiscalCalendar.js +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/fiscalCalendar.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/mappedTrialBalance.d.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/mappedTrialBalance.js +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/mappedTrialBalance.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/mapping.d.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/mapping.js +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/mapping.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/mappingCoverage.d.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/mappingCoverage.js +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/mappingCoverage.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/mappings.d.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/mappings.js +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/mappings.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/periodCloseStatus.d.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/periodCloseStatus.js +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/periodCloseStatus.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/periodDrafts.d.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/periodDrafts.js +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/periodDrafts.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/publishList.d.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/publishList.js +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/publishList.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/publishLists.d.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/publishLists.js +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/publishLists.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/report.d.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/report.js +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/report.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/reportingTaxonomy.d.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/reportingTaxonomy.js +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/reportingTaxonomy.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/reports.d.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/reports.js +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/reports.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/scheduleFacts.d.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/scheduleFacts.js +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/scheduleFacts.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/schedules.d.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/schedules.js +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/schedules.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/statement.d.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/statement.js +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/statement.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/structures.d.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/structures.js +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/structures.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/summary.d.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/summary.js +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/summary.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/taxonomies.d.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/taxonomies.js +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/taxonomies.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/transaction.d.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/transaction.js +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/transaction.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/transactions.d.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/transactions.js +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/transactions.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/trialBalance.d.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/trialBalance.js +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/trialBalance.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/unmappedElements.d.ts +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/unmappedElements.js +0 -0
- /package/{extensions → artifacts}/graphql/queries/ledger/unmappedElements.ts +0 -0
- /package/{extensions → artifacts}/hooks.d.ts +0 -0
package/sdk.gen.js
CHANGED
|
@@ -2,8 +2,9 @@
|
|
|
2
2
|
// This file is auto-generated by @hey-api/openapi-ts
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
4
|
exports.callMcpTool = exports.listMcpTools = exports.recommendAgent = exports.batchProcessQueries = exports.executeSpecificAgent = exports.getAgentMetadata = exports.autoSelectAgent = exports.listAgents = 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
|
-
exports.getOperationStatus = exports.streamOperationEvents = 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.
|
|
6
|
-
exports.
|
|
5
|
+
exports.getOperationStatus = exports.streamOperationEvents = 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.opUpgradeTier = exports.opRestoreBackup = exports.opCreateBackup = exports.opDeleteSubgraph = exports.opCreateSubgraph = exports.uploadDocumentsBulk = exports.updateDocument = exports.getDocument = exports.deleteDocument = exports.uploadDocument = exports.listDocuments = exports.getDocumentSection = exports.searchDocuments = exports.queryTables = exports.listTables = 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
|
+
exports.opDeletePublishList = exports.opUpdatePublishList = exports.opCreatePublishList = exports.opShareReport = exports.opDeleteReport = exports.opRegenerateReport = exports.opCreateReport = exports.opAutoMapElements = exports.opDeleteSchedule = exports.opUpdateSchedule = exports.opReverseJournalEntry = exports.opDeleteJournalEntry = exports.opUpdateJournalEntry = exports.opCreateJournalEntry = exports.opDeleteAssociation = exports.opUpdateAssociation = exports.opCreateAssociations = exports.opDeleteElement = exports.opUpdateElement = exports.opCreateElement = exports.opDeleteStructure = exports.opUpdateStructure = exports.opLinkEntityTaxonomy = exports.opDeleteTaxonomy = exports.opUpdateTaxonomy = exports.opDeleteMappingAssociation = exports.opCreateMappingAssociation = exports.opCreateStructure = exports.opCreateTaxonomy = exports.opCreateManualClosingEntry = exports.opCreateClosingEntry = exports.opTruncateSchedule = exports.opCreateSchedule = exports.opReopenPeriod = exports.opClosePeriod = exports.opSetCloseTarget = exports.opInitializeLedger = exports.opUpdateEntity = exports.handleHttpPostExtensionsGraphIdGraphqlPost = exports.handleHttpGetExtensionsGraphIdGraphqlGet = exports.getCheckoutStatus = exports.createCheckoutSession = exports.getOrgUpcomingInvoice = exports.listOrgInvoices = exports.cancelOrgSubscription = exports.getOrgSubscription = exports.listOrgSubscriptions = exports.createPortalSession = exports.getOrgBillingCustomer = exports.cancelOperation = void 0;
|
|
7
|
+
exports.opDeletePosition = exports.opUpdatePosition = exports.opCreatePosition = exports.opDeleteSecurity = exports.opUpdateSecurity = exports.opCreateSecurity = exports.opDeletePortfolio = exports.opUpdatePortfolio = exports.opCreatePortfolio = exports.opBuildFactGrid = exports.opRemovePublishListMember = exports.opAddPublishListMembers = void 0;
|
|
7
8
|
const client_gen_1 = require("./client.gen");
|
|
8
9
|
/**
|
|
9
10
|
* Register New User
|
|
@@ -905,80 +906,6 @@ const listBackups = (options) => (options.client ?? client_gen_1.client).get({
|
|
|
905
906
|
...options
|
|
906
907
|
});
|
|
907
908
|
exports.listBackups = listBackups;
|
|
908
|
-
/**
|
|
909
|
-
* Create Backup
|
|
910
|
-
*
|
|
911
|
-
* Create a backup of the graph database.
|
|
912
|
-
*
|
|
913
|
-
* Creates a complete backup of the graph database (.lbug file) with:
|
|
914
|
-
* - **Format**: Full database backup only (complete .lbug file)
|
|
915
|
-
* - **Compression**: Always enabled for optimal storage
|
|
916
|
-
* - **Encryption**: Optional AES-256 encryption for security
|
|
917
|
-
* - **Retention**: Configurable retention period (1-2555 days)
|
|
918
|
-
*
|
|
919
|
-
* **Backup Features:**
|
|
920
|
-
* - **Complete Backup**: Full database file backup
|
|
921
|
-
* - **Consistency**: Point-in-time consistent snapshot
|
|
922
|
-
* - **Download Support**: Unencrypted backups can be downloaded
|
|
923
|
-
* - **Restore Support**: Future support for encrypted backup restoration
|
|
924
|
-
*
|
|
925
|
-
* **Operation State Machine:**
|
|
926
|
-
* ```
|
|
927
|
-
* pending → processing → completed
|
|
928
|
-
* ↘ failed
|
|
929
|
-
* ```
|
|
930
|
-
* - **pending**: Backup queued, waiting to start
|
|
931
|
-
* - **processing**: Actively backing up database
|
|
932
|
-
* - **completed**: Backup successfully created and stored
|
|
933
|
-
* - **failed**: Backup failed (check error message)
|
|
934
|
-
*
|
|
935
|
-
* **Expected Durations:**
|
|
936
|
-
* Operation times vary by database size:
|
|
937
|
-
* - **Small** (<1GB): 30 seconds - 2 minutes
|
|
938
|
-
* - **Medium** (1-10GB): 2-10 minutes
|
|
939
|
-
* - **Large** (10-100GB): 10-30 minutes
|
|
940
|
-
* - **Very Large** (>100GB): 30+ minutes
|
|
941
|
-
*
|
|
942
|
-
* **Progress Monitoring:**
|
|
943
|
-
* Use the returned operation_id to connect to the SSE stream:
|
|
944
|
-
* ```javascript
|
|
945
|
-
* const eventSource = new EventSource('/v1/operations/{operation_id}/stream');
|
|
946
|
-
* eventSource.addEventListener('operation_progress', (event) => {
|
|
947
|
-
* const data = JSON.parse(event.data);
|
|
948
|
-
* console.log('Backup progress:', data.progress_percent + '%');
|
|
949
|
-
* console.log('Status:', data.status); // pending, processing, completed, failed
|
|
950
|
-
* });
|
|
951
|
-
* ```
|
|
952
|
-
*
|
|
953
|
-
* **SSE Connection Limits:**
|
|
954
|
-
* - Maximum 5 concurrent SSE connections per user
|
|
955
|
-
* - Rate limited to 10 new connections per minute
|
|
956
|
-
* - Automatic circuit breaker for Redis failures
|
|
957
|
-
* - Graceful degradation if event system unavailable
|
|
958
|
-
*
|
|
959
|
-
* **Important Notes:**
|
|
960
|
-
* - Only full_dump format is supported (no CSV/JSON exports)
|
|
961
|
-
* - Compression is always enabled
|
|
962
|
-
* - Encrypted backups cannot be downloaded (security measure)
|
|
963
|
-
* - All backups are stored securely in cloud storage
|
|
964
|
-
*
|
|
965
|
-
* **Credit Consumption:**
|
|
966
|
-
* - Base cost: 25.0 credits
|
|
967
|
-
* - Large databases (>10GB): 50.0 credits
|
|
968
|
-
* - Multiplied by graph tier
|
|
969
|
-
*
|
|
970
|
-
* Returns operation details for SSE monitoring.
|
|
971
|
-
*/
|
|
972
|
-
const createBackup = (options) => (options.client ?? client_gen_1.client).post({
|
|
973
|
-
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
974
|
-
url: '/v1/graphs/{graph_id}/backups',
|
|
975
|
-
...options,
|
|
976
|
-
headers: {
|
|
977
|
-
'Content-Type': 'application/json',
|
|
978
|
-
...options.headers
|
|
979
|
-
}
|
|
980
|
-
});
|
|
981
|
-
exports.createBackup = createBackup;
|
|
982
909
|
/**
|
|
983
910
|
* Get temporary download URL for backup
|
|
984
911
|
*
|
|
@@ -990,85 +917,6 @@ const getBackupDownloadUrl = (options) => (options.client ?? client_gen_1.client
|
|
|
990
917
|
...options
|
|
991
918
|
});
|
|
992
919
|
exports.getBackupDownloadUrl = getBackupDownloadUrl;
|
|
993
|
-
/**
|
|
994
|
-
* Restore Encrypted Backup
|
|
995
|
-
*
|
|
996
|
-
* Restore a graph database from an encrypted backup.
|
|
997
|
-
*
|
|
998
|
-
* Restores a complete graph database from an encrypted backup:
|
|
999
|
-
* - **Format**: Only full_dump backups can be restored
|
|
1000
|
-
* - **Encryption**: Only encrypted backups can be restored (security requirement)
|
|
1001
|
-
* - **System Backup**: Creates automatic backup of existing database before restore
|
|
1002
|
-
* - **Verification**: Optionally verifies database integrity after restore
|
|
1003
|
-
*
|
|
1004
|
-
* **Restore Features:**
|
|
1005
|
-
* - **Atomic Operation**: Complete replacement of database
|
|
1006
|
-
* - **Rollback Protection**: System backup created before restore
|
|
1007
|
-
* - **Data Integrity**: Verification ensures successful restore
|
|
1008
|
-
* - **Security**: Only encrypted backups to prevent data tampering
|
|
1009
|
-
*
|
|
1010
|
-
* **Operation State Machine:**
|
|
1011
|
-
* ```
|
|
1012
|
-
* pending → backing_up_current → downloading → restoring → verifying → completed
|
|
1013
|
-
* ↘ failed
|
|
1014
|
-
* ```
|
|
1015
|
-
* - **pending**: Restore queued, waiting to start
|
|
1016
|
-
* - **backing_up_current**: Creating safety backup of existing database
|
|
1017
|
-
* - **downloading**: Downloading backup from storage
|
|
1018
|
-
* - **restoring**: Replacing database with backup contents
|
|
1019
|
-
* - **verifying**: Verifying database integrity (if enabled)
|
|
1020
|
-
* - **completed**: Restore successful, database operational
|
|
1021
|
-
* - **failed**: Restore failed (rollback may be available)
|
|
1022
|
-
*
|
|
1023
|
-
* **Expected Durations:**
|
|
1024
|
-
* Operation times vary by database size (includes backup + restore):
|
|
1025
|
-
* - **Small** (<1GB): 1-3 minutes
|
|
1026
|
-
* - **Medium** (1-10GB): 5-15 minutes
|
|
1027
|
-
* - **Large** (10-100GB): 20-45 minutes
|
|
1028
|
-
* - **Very Large** (>100GB): 45+ minutes
|
|
1029
|
-
*
|
|
1030
|
-
* Note: Restore operations take longer than backups due to safety backup step.
|
|
1031
|
-
*
|
|
1032
|
-
* **Progress Monitoring:**
|
|
1033
|
-
* Use the returned operation_id to connect to the SSE stream:
|
|
1034
|
-
* ```javascript
|
|
1035
|
-
* const eventSource = new EventSource('/v1/operations/{operation_id}/stream');
|
|
1036
|
-
* eventSource.addEventListener('operation_progress', (event) => {
|
|
1037
|
-
* const data = JSON.parse(event.data);
|
|
1038
|
-
* console.log('Restore progress:', data.message);
|
|
1039
|
-
* console.log('Status:', data.status); // Shows current state
|
|
1040
|
-
* });
|
|
1041
|
-
* ```
|
|
1042
|
-
*
|
|
1043
|
-
* **SSE Connection Limits:**
|
|
1044
|
-
* - Maximum 5 concurrent SSE connections per user
|
|
1045
|
-
* - Rate limited to 10 new connections per minute
|
|
1046
|
-
* - Automatic circuit breaker for Redis failures
|
|
1047
|
-
* - Graceful degradation if event system unavailable
|
|
1048
|
-
*
|
|
1049
|
-
* **Important Notes:**
|
|
1050
|
-
* - Only encrypted backups can be restored (security measure)
|
|
1051
|
-
* - Existing database is backed up to S3 before restore
|
|
1052
|
-
* - Restore is a destructive operation - existing data is replaced
|
|
1053
|
-
* - System backups are stored separately for recovery
|
|
1054
|
-
*
|
|
1055
|
-
* **Credit Consumption:**
|
|
1056
|
-
* - Base cost: 100.0 credits
|
|
1057
|
-
* - Large databases (>10GB): 200.0 credits
|
|
1058
|
-
* - Multiplied by graph tier
|
|
1059
|
-
*
|
|
1060
|
-
* Returns operation details for SSE monitoring.
|
|
1061
|
-
*/
|
|
1062
|
-
const restoreBackup = (options) => (options.client ?? client_gen_1.client).post({
|
|
1063
|
-
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1064
|
-
url: '/v1/graphs/{graph_id}/backups/{backup_id}/restore',
|
|
1065
|
-
...options,
|
|
1066
|
-
headers: {
|
|
1067
|
-
'Content-Type': 'application/json',
|
|
1068
|
-
...options.headers
|
|
1069
|
-
}
|
|
1070
|
-
});
|
|
1071
|
-
exports.restoreBackup = restoreBackup;
|
|
1072
920
|
/**
|
|
1073
921
|
* Get backup statistics
|
|
1074
922
|
*
|
|
@@ -1538,85 +1386,6 @@ const listSubgraphs = (options) => (options.client ?? client_gen_1.client).get({
|
|
|
1538
1386
|
...options
|
|
1539
1387
|
});
|
|
1540
1388
|
exports.listSubgraphs = listSubgraphs;
|
|
1541
|
-
/**
|
|
1542
|
-
* Create Subgraph
|
|
1543
|
-
*
|
|
1544
|
-
* Create a new subgraph within a parent graph, with optional data forking.
|
|
1545
|
-
*
|
|
1546
|
-
* **Requirements:**
|
|
1547
|
-
* - Valid authentication
|
|
1548
|
-
* - Parent graph must exist and be accessible to the user
|
|
1549
|
-
* - User must have 'admin' permission on the parent graph
|
|
1550
|
-
* - Parent graph tier must support subgraphs (LadybugDB Large/XLarge)
|
|
1551
|
-
* - Must be within subgraph quota limits
|
|
1552
|
-
* - Subgraph name must be unique within the parent graph
|
|
1553
|
-
*
|
|
1554
|
-
* **Fork Mode:**
|
|
1555
|
-
* When `fork_parent=true`, the operation:
|
|
1556
|
-
* - Returns immediately with an operation_id for SSE monitoring
|
|
1557
|
-
* - Copies data from parent graph to the new subgraph
|
|
1558
|
-
* - Supports selective forking via metadata.fork_options
|
|
1559
|
-
* - Tracks progress in real-time via SSE
|
|
1560
|
-
*
|
|
1561
|
-
* **Returns:**
|
|
1562
|
-
* - Without fork: Immediate SubgraphResponse with created subgraph details
|
|
1563
|
-
* - With fork: Operation response with SSE monitoring endpoint
|
|
1564
|
-
*
|
|
1565
|
-
* **Subgraph ID format:** `{parent_id}_{subgraph_name}` (e.g., kg1234567890abcdef_dev)
|
|
1566
|
-
*
|
|
1567
|
-
* **Usage:**
|
|
1568
|
-
* - Subgraphs share parent's credit pool
|
|
1569
|
-
* - Subgraph ID can be used in all standard `/v1/graphs/{graph_id}*` endpoints
|
|
1570
|
-
* - Permissions inherited from parent graph
|
|
1571
|
-
*/
|
|
1572
|
-
const createSubgraph = (options) => (options.client ?? client_gen_1.client).post({
|
|
1573
|
-
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1574
|
-
url: '/v1/graphs/{graph_id}/subgraphs',
|
|
1575
|
-
...options,
|
|
1576
|
-
headers: {
|
|
1577
|
-
'Content-Type': 'application/json',
|
|
1578
|
-
...options.headers
|
|
1579
|
-
}
|
|
1580
|
-
});
|
|
1581
|
-
exports.createSubgraph = createSubgraph;
|
|
1582
|
-
/**
|
|
1583
|
-
* Delete Subgraph
|
|
1584
|
-
*
|
|
1585
|
-
* Delete a subgraph database.
|
|
1586
|
-
*
|
|
1587
|
-
* **Requirements:**
|
|
1588
|
-
* - Must be a valid subgraph (not parent graph)
|
|
1589
|
-
* - User must have admin access to parent graph
|
|
1590
|
-
* - Subgraph name must be alphanumeric (1-20 characters)
|
|
1591
|
-
* - Optional backup before deletion
|
|
1592
|
-
*
|
|
1593
|
-
* **Deletion Options:**
|
|
1594
|
-
* - `force`: Delete even if contains data
|
|
1595
|
-
* - `backup_first`: Create backup before deletion
|
|
1596
|
-
*
|
|
1597
|
-
* **Warning:**
|
|
1598
|
-
* Deletion is permanent unless backup is created.
|
|
1599
|
-
* All data in the subgraph will be lost.
|
|
1600
|
-
*
|
|
1601
|
-
* **Backup Location:**
|
|
1602
|
-
* If backup requested, stored in S3 graph database bucket at:
|
|
1603
|
-
* `s3://{graph_s3_bucket}/{instance_id}/{database_name}_{timestamp}.backup`
|
|
1604
|
-
*
|
|
1605
|
-
* **Notes:**
|
|
1606
|
-
* - Use the subgraph name (e.g., 'dev', 'staging') not the full subgraph ID
|
|
1607
|
-
* - Deletion does not affect parent graph's credit pool or permissions
|
|
1608
|
-
* - Backup creation consumes credits from parent graph's allocation
|
|
1609
|
-
*/
|
|
1610
|
-
const deleteSubgraph = (options) => (options.client ?? client_gen_1.client).delete({
|
|
1611
|
-
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1612
|
-
url: '/v1/graphs/{graph_id}/subgraphs/{subgraph_name}',
|
|
1613
|
-
...options,
|
|
1614
|
-
headers: {
|
|
1615
|
-
'Content-Type': 'application/json',
|
|
1616
|
-
...options.headers
|
|
1617
|
-
}
|
|
1618
|
-
});
|
|
1619
|
-
exports.deleteSubgraph = deleteSubgraph;
|
|
1620
1389
|
/**
|
|
1621
1390
|
* Get Subgraph Details
|
|
1622
1391
|
*
|
|
@@ -1647,7 +1416,7 @@ exports.deleteSubgraph = deleteSubgraph;
|
|
|
1647
1416
|
*/
|
|
1648
1417
|
const getSubgraphInfo = (options) => (options.client ?? client_gen_1.client).get({
|
|
1649
1418
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1650
|
-
url: '/v1/graphs/{graph_id}/subgraphs/{subgraph_name}
|
|
1419
|
+
url: '/v1/graphs/{graph_id}/subgraphs/{subgraph_name}',
|
|
1651
1420
|
...options
|
|
1652
1421
|
});
|
|
1653
1422
|
exports.getSubgraphInfo = getSubgraphInfo;
|
|
@@ -1965,108 +1734,109 @@ const uploadDocumentsBulk = (options) => (options.client ?? client_gen_1.client)
|
|
|
1965
1734
|
});
|
|
1966
1735
|
exports.uploadDocumentsBulk = uploadDocumentsBulk;
|
|
1967
1736
|
/**
|
|
1968
|
-
*
|
|
1969
|
-
*
|
|
1970
|
-
* Get current materialization status for the graph.
|
|
1971
|
-
*
|
|
1972
|
-
* Shows whether the graph is stale (DuckDB has changes not yet in graph database),
|
|
1973
|
-
* when it was last materialized, and how long since last materialization.
|
|
1974
|
-
*
|
|
1975
|
-
* **Status Information:**
|
|
1976
|
-
* - Whether graph is currently stale
|
|
1977
|
-
* - Reason for staleness if applicable
|
|
1978
|
-
* - When graph became stale
|
|
1979
|
-
* - When graph was last materialized
|
|
1980
|
-
* - Total materialization count
|
|
1981
|
-
* - Hours since last materialization
|
|
1737
|
+
* Create Subgraph
|
|
1982
1738
|
*
|
|
1983
|
-
*
|
|
1984
|
-
* - Decide if materialization is needed
|
|
1985
|
-
* - Monitor graph freshness
|
|
1986
|
-
* - Track materialization history
|
|
1987
|
-
* - Understand data pipeline state
|
|
1739
|
+
* Create a new subgraph, optionally forking parent data.
|
|
1988
1740
|
*
|
|
1989
|
-
* **
|
|
1990
|
-
* - Stale graph means DuckDB has changes not in graph
|
|
1991
|
-
* - Graph becomes stale after file deletions
|
|
1992
|
-
* - Materialization clears staleness
|
|
1993
|
-
* - Status retrieval is included - no credit consumption
|
|
1741
|
+
* **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.
|
|
1994
1742
|
*/
|
|
1995
|
-
const
|
|
1743
|
+
const opCreateSubgraph = (options) => (options.client ?? client_gen_1.client).post({
|
|
1996
1744
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1997
|
-
url: '/v1/graphs/{graph_id}/
|
|
1998
|
-
...options
|
|
1745
|
+
url: '/v1/graphs/{graph_id}/operations/create-subgraph',
|
|
1746
|
+
...options,
|
|
1747
|
+
headers: {
|
|
1748
|
+
'Content-Type': 'application/json',
|
|
1749
|
+
...options.headers
|
|
1750
|
+
}
|
|
1999
1751
|
});
|
|
2000
|
-
exports.
|
|
1752
|
+
exports.opCreateSubgraph = opCreateSubgraph;
|
|
2001
1753
|
/**
|
|
2002
|
-
*
|
|
2003
|
-
*
|
|
2004
|
-
* Rebuild entire graph from DuckDB staging tables (materialized view pattern).
|
|
2005
|
-
*
|
|
2006
|
-
* This endpoint rebuilds the complete graph database from the current state of DuckDB
|
|
2007
|
-
* staging tables. It automatically discovers all tables, ingests them in the correct
|
|
2008
|
-
* order (nodes before relationships), and clears the staleness flag.
|
|
2009
|
-
*
|
|
2010
|
-
* **When to Use:**
|
|
2011
|
-
* - After batch uploads (files uploaded with ingest_to_graph=false)
|
|
2012
|
-
* - After cascade file deletions (graph marked stale)
|
|
2013
|
-
* - To ensure graph consistency with DuckDB state
|
|
2014
|
-
* - Periodic full refresh
|
|
1754
|
+
* Delete Subgraph
|
|
2015
1755
|
*
|
|
2016
|
-
*
|
|
2017
|
-
* 1. Discovers all tables for the graph from PostgreSQL registry
|
|
2018
|
-
* 2. Sorts tables (nodes before relationships)
|
|
2019
|
-
* 3. Ingests all tables from DuckDB to graph in order
|
|
2020
|
-
* 4. Clears staleness flag on success
|
|
2021
|
-
* 5. Returns detailed materialization report
|
|
1756
|
+
* Delete a subgraph database.
|
|
2022
1757
|
*
|
|
2023
|
-
* **
|
|
2024
|
-
|
|
2025
|
-
|
|
1758
|
+
* **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.
|
|
1759
|
+
*/
|
|
1760
|
+
const opDeleteSubgraph = (options) => (options.client ?? client_gen_1.client).post({
|
|
1761
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1762
|
+
url: '/v1/graphs/{graph_id}/operations/delete-subgraph',
|
|
1763
|
+
...options,
|
|
1764
|
+
headers: {
|
|
1765
|
+
'Content-Type': 'application/json',
|
|
1766
|
+
...options.headers
|
|
1767
|
+
}
|
|
1768
|
+
});
|
|
1769
|
+
exports.opDeleteSubgraph = opDeleteSubgraph;
|
|
1770
|
+
/**
|
|
1771
|
+
* Create Backup
|
|
2026
1772
|
*
|
|
2027
|
-
*
|
|
2028
|
-
* Setting `rebuild=true` regenerates the entire graph database from scratch:
|
|
2029
|
-
* - Deletes existing graph database
|
|
2030
|
-
* - Recreates with fresh schema from active GraphSchema
|
|
2031
|
-
* - Ingests all data files
|
|
2032
|
-
* - Safe operation - DuckDB is source of truth
|
|
2033
|
-
* - Useful for schema changes or data corrections
|
|
2034
|
-
* - Graph marked as 'rebuilding' during process
|
|
1773
|
+
* Create a backup of the graph database (async).
|
|
2035
1774
|
*
|
|
2036
|
-
* **
|
|
2037
|
-
|
|
2038
|
-
|
|
1775
|
+
* **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.
|
|
1776
|
+
*/
|
|
1777
|
+
const opCreateBackup = (options) => (options.client ?? client_gen_1.client).post({
|
|
1778
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1779
|
+
url: '/v1/graphs/{graph_id}/operations/create-backup',
|
|
1780
|
+
...options,
|
|
1781
|
+
headers: {
|
|
1782
|
+
'Content-Type': 'application/json',
|
|
1783
|
+
...options.headers
|
|
1784
|
+
}
|
|
1785
|
+
});
|
|
1786
|
+
exports.opCreateBackup = opCreateBackup;
|
|
1787
|
+
/**
|
|
1788
|
+
* Restore Backup
|
|
2039
1789
|
*
|
|
2040
|
-
*
|
|
2041
|
-
* With `ignore_errors=true` (default), continues materializing even if individual
|
|
2042
|
-
* rows fail. Failed rows are logged but don't stop the process.
|
|
1790
|
+
* Restore a graph database from an encrypted backup.
|
|
2043
1791
|
*
|
|
2044
|
-
*
|
|
2045
|
-
*
|
|
2046
|
-
* you'll receive a 409 Conflict error. The distributed lock automatically expires after
|
|
2047
|
-
* the configured TTL (default: 1 hour) to prevent deadlocks from failed materializations.
|
|
1792
|
+
* Blocked for entity graphs — OLTP is the source of truth, use
|
|
1793
|
+
* the materialize operation instead.
|
|
2048
1794
|
*
|
|
2049
|
-
* **
|
|
2050
|
-
|
|
2051
|
-
|
|
1795
|
+
* **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.
|
|
1796
|
+
*/
|
|
1797
|
+
const opRestoreBackup = (options) => (options.client ?? client_gen_1.client).post({
|
|
1798
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1799
|
+
url: '/v1/graphs/{graph_id}/operations/restore-backup',
|
|
1800
|
+
...options,
|
|
1801
|
+
headers: {
|
|
1802
|
+
'Content-Type': 'application/json',
|
|
1803
|
+
...options.headers
|
|
1804
|
+
}
|
|
1805
|
+
});
|
|
1806
|
+
exports.opRestoreBackup = opRestoreBackup;
|
|
1807
|
+
/**
|
|
1808
|
+
* Upgrade Tier
|
|
2052
1809
|
*
|
|
2053
|
-
*
|
|
2054
|
-
* Set `dry_run=true` to validate limits without executing. Returns current usage, tier limits,
|
|
2055
|
-
* and any warnings or errors. No lock is acquired, no SSE operation is created.
|
|
1810
|
+
* Change the infrastructure tier on a graph (async EBS migration).
|
|
2056
1811
|
*
|
|
2057
|
-
* **
|
|
2058
|
-
* Materialization is included - no credit consumption
|
|
1812
|
+
* **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.
|
|
2059
1813
|
*/
|
|
2060
|
-
const
|
|
1814
|
+
const opUpgradeTier = (options) => (options.client ?? client_gen_1.client).post({
|
|
2061
1815
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2062
|
-
url: '/v1/graphs/{graph_id}/
|
|
1816
|
+
url: '/v1/graphs/{graph_id}/operations/upgrade-tier',
|
|
2063
1817
|
...options,
|
|
2064
1818
|
headers: {
|
|
2065
1819
|
'Content-Type': 'application/json',
|
|
2066
1820
|
...options.headers
|
|
2067
1821
|
}
|
|
2068
1822
|
});
|
|
2069
|
-
exports.
|
|
1823
|
+
exports.opUpgradeTier = opUpgradeTier;
|
|
1824
|
+
/**
|
|
1825
|
+
* Materialize Graph
|
|
1826
|
+
*
|
|
1827
|
+
* Materialize graph from staging tables or extensions OLTP.
|
|
1828
|
+
*
|
|
1829
|
+
* Delegates to the existing materialize_graph handler which handles
|
|
1830
|
+
* distributed locking, source routing, and Dagster/direct dispatch.
|
|
1831
|
+
*
|
|
1832
|
+
* **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.
|
|
1833
|
+
*/
|
|
1834
|
+
const opMaterialize = (options) => (options.client ?? client_gen_1.client).post({
|
|
1835
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1836
|
+
url: '/v1/graphs/{graph_id}/operations/materialize',
|
|
1837
|
+
...options
|
|
1838
|
+
});
|
|
1839
|
+
exports.opMaterialize = opMaterialize;
|
|
2070
1840
|
/**
|
|
2071
1841
|
* List Files in Graph
|
|
2072
1842
|
*
|
|
@@ -2857,6 +2627,12 @@ const getCheckoutStatus = (options) => (options.client ?? client_gen_1.client).g
|
|
|
2857
2627
|
exports.getCheckoutStatus = getCheckoutStatus;
|
|
2858
2628
|
/**
|
|
2859
2629
|
* Handle Http Get
|
|
2630
|
+
*
|
|
2631
|
+
*
|
|
2632
|
+
*
|
|
2633
|
+
* **Auth**: pass `X-API-Key` (or a JWT `Authorization: Bearer` header). Unauthenticated introspection queries are deliberately allowed for SDK codegen; data queries require credentials and raise `UNAUTHENTICATED`.
|
|
2634
|
+
*
|
|
2635
|
+
* **Error codes**: `LEDGER_NOT_INITIALIZED`, `INVESTOR_NOT_INITIALIZED`, and `UNAUTHENTICATED` surface in the GraphQL `errors[].extensions.code` field — see `graphql/README.md` for the full vocabulary.
|
|
2860
2636
|
*/
|
|
2861
2637
|
const handleHttpGetExtensionsGraphIdGraphqlGet = (options) => (options.client ?? client_gen_1.client).get({
|
|
2862
2638
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -2866,6 +2642,12 @@ const handleHttpGetExtensionsGraphIdGraphqlGet = (options) => (options.client ??
|
|
|
2866
2642
|
exports.handleHttpGetExtensionsGraphIdGraphqlGet = handleHttpGetExtensionsGraphIdGraphqlGet;
|
|
2867
2643
|
/**
|
|
2868
2644
|
* Handle Http Post
|
|
2645
|
+
*
|
|
2646
|
+
*
|
|
2647
|
+
*
|
|
2648
|
+
* **Auth**: pass `X-API-Key` (or a JWT `Authorization: Bearer` header). Unauthenticated introspection queries are deliberately allowed for SDK codegen; data queries require credentials and raise `UNAUTHENTICATED`.
|
|
2649
|
+
*
|
|
2650
|
+
* **Error codes**: `LEDGER_NOT_INITIALIZED`, `INVESTOR_NOT_INITIALIZED`, and `UNAUTHENTICATED` surface in the GraphQL `errors[].extensions.code` field — see `graphql/README.md` for the full vocabulary.
|
|
2869
2651
|
*/
|
|
2870
2652
|
const handleHttpPostExtensionsGraphIdGraphqlPost = (options) => (options.client ?? client_gen_1.client).post({
|
|
2871
2653
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -2877,6 +2659,8 @@ exports.handleHttpPostExtensionsGraphIdGraphqlPost = handleHttpPostExtensionsGra
|
|
|
2877
2659
|
* Update Entity
|
|
2878
2660
|
*
|
|
2879
2661
|
* Update entity details. Only provided (non-null) fields are updated.
|
|
2662
|
+
*
|
|
2663
|
+
* **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.
|
|
2880
2664
|
*/
|
|
2881
2665
|
const opUpdateEntity = (options) => (options.client ?? client_gen_1.client).post({
|
|
2882
2666
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -2892,6 +2676,8 @@ exports.opUpdateEntity = opUpdateEntity;
|
|
|
2892
2676
|
* Initialize Ledger
|
|
2893
2677
|
*
|
|
2894
2678
|
* One-time ledger initialization — create fiscal calendar + seed periods.
|
|
2679
|
+
*
|
|
2680
|
+
* **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.
|
|
2895
2681
|
*/
|
|
2896
2682
|
const opInitializeLedger = (options) => (options.client ?? client_gen_1.client).post({
|
|
2897
2683
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -2907,6 +2693,8 @@ exports.opInitializeLedger = opInitializeLedger;
|
|
|
2907
2693
|
* Set Close Target
|
|
2908
2694
|
*
|
|
2909
2695
|
* Set the user-controlled close target (YYYY-MM).
|
|
2696
|
+
*
|
|
2697
|
+
* **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.
|
|
2910
2698
|
*/
|
|
2911
2699
|
const opSetCloseTarget = (options) => (options.client ?? client_gen_1.client).post({
|
|
2912
2700
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -2922,6 +2710,8 @@ exports.opSetCloseTarget = opSetCloseTarget;
|
|
|
2922
2710
|
* Close Fiscal Period
|
|
2923
2711
|
*
|
|
2924
2712
|
* Close a fiscal period — the final commit action.
|
|
2713
|
+
*
|
|
2714
|
+
* **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.
|
|
2925
2715
|
*/
|
|
2926
2716
|
const opClosePeriod = (options) => (options.client ?? client_gen_1.client).post({
|
|
2927
2717
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -2937,6 +2727,8 @@ exports.opClosePeriod = opClosePeriod;
|
|
|
2937
2727
|
* Reopen Fiscal Period
|
|
2938
2728
|
*
|
|
2939
2729
|
* Reopen a closed fiscal period — decrements `closed_through`.
|
|
2730
|
+
*
|
|
2731
|
+
* **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.
|
|
2940
2732
|
*/
|
|
2941
2733
|
const opReopenPeriod = (options) => (options.client ?? client_gen_1.client).post({
|
|
2942
2734
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -2952,6 +2744,8 @@ exports.opReopenPeriod = opReopenPeriod;
|
|
|
2952
2744
|
* Create Schedule
|
|
2953
2745
|
*
|
|
2954
2746
|
* Create a schedule with pre-generated monthly facts.
|
|
2747
|
+
*
|
|
2748
|
+
* **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.
|
|
2955
2749
|
*/
|
|
2956
2750
|
const opCreateSchedule = (options) => (options.client ?? client_gen_1.client).post({
|
|
2957
2751
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -2967,6 +2761,8 @@ exports.opCreateSchedule = opCreateSchedule;
|
|
|
2967
2761
|
* Truncate Schedule (End Early)
|
|
2968
2762
|
*
|
|
2969
2763
|
* End a schedule early — delete forward facts + stale drafts.
|
|
2764
|
+
*
|
|
2765
|
+
* **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.
|
|
2970
2766
|
*/
|
|
2971
2767
|
const opTruncateSchedule = (options) => (options.client ?? client_gen_1.client).post({
|
|
2972
2768
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -2982,6 +2778,8 @@ exports.opTruncateSchedule = opTruncateSchedule;
|
|
|
2982
2778
|
* Create Closing Entry
|
|
2983
2779
|
*
|
|
2984
2780
|
* Create a draft closing entry from a schedule's facts for a period.
|
|
2781
|
+
*
|
|
2782
|
+
* **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.
|
|
2985
2783
|
*/
|
|
2986
2784
|
const opCreateClosingEntry = (options) => (options.client ?? client_gen_1.client).post({
|
|
2987
2785
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -2997,6 +2795,8 @@ exports.opCreateClosingEntry = opCreateClosingEntry;
|
|
|
2997
2795
|
* Create Manual Closing Entry
|
|
2998
2796
|
*
|
|
2999
2797
|
* Create a manual (non-schedule) draft closing entry.
|
|
2798
|
+
*
|
|
2799
|
+
* **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.
|
|
3000
2800
|
*/
|
|
3001
2801
|
const opCreateManualClosingEntry = (options) => (options.client ?? client_gen_1.client).post({
|
|
3002
2802
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3012,6 +2812,8 @@ exports.opCreateManualClosingEntry = opCreateManualClosingEntry;
|
|
|
3012
2812
|
* Create Taxonomy
|
|
3013
2813
|
*
|
|
3014
2814
|
* Create a new taxonomy definition.
|
|
2815
|
+
*
|
|
2816
|
+
* **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.
|
|
3015
2817
|
*/
|
|
3016
2818
|
const opCreateTaxonomy = (options) => (options.client ?? client_gen_1.client).post({
|
|
3017
2819
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3027,6 +2829,8 @@ exports.opCreateTaxonomy = opCreateTaxonomy;
|
|
|
3027
2829
|
* Create Structure
|
|
3028
2830
|
*
|
|
3029
2831
|
* Create a new structure (statement, mapping, schedule, etc.).
|
|
2832
|
+
*
|
|
2833
|
+
* **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.
|
|
3030
2834
|
*/
|
|
3031
2835
|
const opCreateStructure = (options) => (options.client ?? client_gen_1.client).post({
|
|
3032
2836
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3042,6 +2846,8 @@ exports.opCreateStructure = opCreateStructure;
|
|
|
3042
2846
|
* Create Mapping Association
|
|
3043
2847
|
*
|
|
3044
2848
|
* Add a mapping association (CoA element → reporting concept).
|
|
2849
|
+
*
|
|
2850
|
+
* **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.
|
|
3045
2851
|
*/
|
|
3046
2852
|
const opCreateMappingAssociation = (options) => (options.client ?? client_gen_1.client).post({
|
|
3047
2853
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3057,6 +2863,8 @@ exports.opCreateMappingAssociation = opCreateMappingAssociation;
|
|
|
3057
2863
|
* Delete Mapping Association
|
|
3058
2864
|
*
|
|
3059
2865
|
* Remove a mapping association.
|
|
2866
|
+
*
|
|
2867
|
+
* **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.
|
|
3060
2868
|
*/
|
|
3061
2869
|
const opDeleteMappingAssociation = (options) => (options.client ?? client_gen_1.client).post({
|
|
3062
2870
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3068,6 +2876,295 @@ const opDeleteMappingAssociation = (options) => (options.client ?? client_gen_1.
|
|
|
3068
2876
|
}
|
|
3069
2877
|
});
|
|
3070
2878
|
exports.opDeleteMappingAssociation = opDeleteMappingAssociation;
|
|
2879
|
+
/**
|
|
2880
|
+
* Update Taxonomy
|
|
2881
|
+
*
|
|
2882
|
+
* Update mutable fields on a taxonomy. `taxonomy_type` is immutable.
|
|
2883
|
+
*
|
|
2884
|
+
* **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.
|
|
2885
|
+
*/
|
|
2886
|
+
const opUpdateTaxonomy = (options) => (options.client ?? client_gen_1.client).post({
|
|
2887
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2888
|
+
url: '/extensions/roboledger/{graph_id}/operations/update-taxonomy',
|
|
2889
|
+
...options,
|
|
2890
|
+
headers: {
|
|
2891
|
+
'Content-Type': 'application/json',
|
|
2892
|
+
...options.headers
|
|
2893
|
+
}
|
|
2894
|
+
});
|
|
2895
|
+
exports.opUpdateTaxonomy = opUpdateTaxonomy;
|
|
2896
|
+
/**
|
|
2897
|
+
* Delete Taxonomy
|
|
2898
|
+
*
|
|
2899
|
+
* Soft-delete a taxonomy (sets `is_active=false`). Historical references remain valid.
|
|
2900
|
+
*
|
|
2901
|
+
* **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.
|
|
2902
|
+
*/
|
|
2903
|
+
const opDeleteTaxonomy = (options) => (options.client ?? client_gen_1.client).post({
|
|
2904
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2905
|
+
url: '/extensions/roboledger/{graph_id}/operations/delete-taxonomy',
|
|
2906
|
+
...options,
|
|
2907
|
+
headers: {
|
|
2908
|
+
'Content-Type': 'application/json',
|
|
2909
|
+
...options.headers
|
|
2910
|
+
}
|
|
2911
|
+
});
|
|
2912
|
+
exports.opDeleteTaxonomy = opDeleteTaxonomy;
|
|
2913
|
+
/**
|
|
2914
|
+
* Link Entity to Taxonomy
|
|
2915
|
+
*
|
|
2916
|
+
* Link the graph's entity to a taxonomy (creates the ENTITY_HAS_TAXONOMY edge). Idempotent — returns existing linkage if it already exists. Required after creating a CoA taxonomy so the platform knows which chart of accounts the entity reports under.
|
|
2917
|
+
*
|
|
2918
|
+
* **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.
|
|
2919
|
+
*/
|
|
2920
|
+
const opLinkEntityTaxonomy = (options) => (options.client ?? client_gen_1.client).post({
|
|
2921
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2922
|
+
url: '/extensions/roboledger/{graph_id}/operations/link-entity-taxonomy',
|
|
2923
|
+
...options,
|
|
2924
|
+
headers: {
|
|
2925
|
+
'Content-Type': 'application/json',
|
|
2926
|
+
...options.headers
|
|
2927
|
+
}
|
|
2928
|
+
});
|
|
2929
|
+
exports.opLinkEntityTaxonomy = opLinkEntityTaxonomy;
|
|
2930
|
+
/**
|
|
2931
|
+
* Update Structure
|
|
2932
|
+
*
|
|
2933
|
+
* Update mutable fields on a structure. `structure_type` and `taxonomy_id` are immutable.
|
|
2934
|
+
*
|
|
2935
|
+
* **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.
|
|
2936
|
+
*/
|
|
2937
|
+
const opUpdateStructure = (options) => (options.client ?? client_gen_1.client).post({
|
|
2938
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2939
|
+
url: '/extensions/roboledger/{graph_id}/operations/update-structure',
|
|
2940
|
+
...options,
|
|
2941
|
+
headers: {
|
|
2942
|
+
'Content-Type': 'application/json',
|
|
2943
|
+
...options.headers
|
|
2944
|
+
}
|
|
2945
|
+
});
|
|
2946
|
+
exports.opUpdateStructure = opUpdateStructure;
|
|
2947
|
+
/**
|
|
2948
|
+
* Delete Structure
|
|
2949
|
+
*
|
|
2950
|
+
* Soft-delete a structure (sets `is_active=false`). Associations referencing it are effectively orphaned.
|
|
2951
|
+
*
|
|
2952
|
+
* **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.
|
|
2953
|
+
*/
|
|
2954
|
+
const opDeleteStructure = (options) => (options.client ?? client_gen_1.client).post({
|
|
2955
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2956
|
+
url: '/extensions/roboledger/{graph_id}/operations/delete-structure',
|
|
2957
|
+
...options,
|
|
2958
|
+
headers: {
|
|
2959
|
+
'Content-Type': 'application/json',
|
|
2960
|
+
...options.headers
|
|
2961
|
+
}
|
|
2962
|
+
});
|
|
2963
|
+
exports.opDeleteStructure = opDeleteStructure;
|
|
2964
|
+
/**
|
|
2965
|
+
* Create Element
|
|
2966
|
+
*
|
|
2967
|
+
* Create an element within a taxonomy. For chart-of-accounts taxonomies this is how native accounts are added.
|
|
2968
|
+
*
|
|
2969
|
+
* **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.
|
|
2970
|
+
*/
|
|
2971
|
+
const opCreateElement = (options) => (options.client ?? client_gen_1.client).post({
|
|
2972
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2973
|
+
url: '/extensions/roboledger/{graph_id}/operations/create-element',
|
|
2974
|
+
...options,
|
|
2975
|
+
headers: {
|
|
2976
|
+
'Content-Type': 'application/json',
|
|
2977
|
+
...options.headers
|
|
2978
|
+
}
|
|
2979
|
+
});
|
|
2980
|
+
exports.opCreateElement = opCreateElement;
|
|
2981
|
+
/**
|
|
2982
|
+
* Update Element
|
|
2983
|
+
*
|
|
2984
|
+
* Update mutable fields on an element. `taxonomy_id` and `source` are immutable. Reparenting cascades path/depth to descendants.
|
|
2985
|
+
*
|
|
2986
|
+
* **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.
|
|
2987
|
+
*/
|
|
2988
|
+
const opUpdateElement = (options) => (options.client ?? client_gen_1.client).post({
|
|
2989
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2990
|
+
url: '/extensions/roboledger/{graph_id}/operations/update-element',
|
|
2991
|
+
...options,
|
|
2992
|
+
headers: {
|
|
2993
|
+
'Content-Type': 'application/json',
|
|
2994
|
+
...options.headers
|
|
2995
|
+
}
|
|
2996
|
+
});
|
|
2997
|
+
exports.opUpdateElement = opUpdateElement;
|
|
2998
|
+
/**
|
|
2999
|
+
* Delete Element
|
|
3000
|
+
*
|
|
3001
|
+
* Soft-delete an element (sets `is_active=false`). Historical line items referencing it remain valid.
|
|
3002
|
+
*
|
|
3003
|
+
* **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.
|
|
3004
|
+
*/
|
|
3005
|
+
const opDeleteElement = (options) => (options.client ?? client_gen_1.client).post({
|
|
3006
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
3007
|
+
url: '/extensions/roboledger/{graph_id}/operations/delete-element',
|
|
3008
|
+
...options,
|
|
3009
|
+
headers: {
|
|
3010
|
+
'Content-Type': 'application/json',
|
|
3011
|
+
...options.headers
|
|
3012
|
+
}
|
|
3013
|
+
});
|
|
3014
|
+
exports.opDeleteElement = opDeleteElement;
|
|
3015
|
+
/**
|
|
3016
|
+
* Create Associations (Bulk)
|
|
3017
|
+
*
|
|
3018
|
+
* Create N associations in a single structure, atomically. Handles 50+ presentation arcs, 25+ calculation arcs, or a full table linkbase in one call. Any failed row rolls back the batch.
|
|
3019
|
+
*
|
|
3020
|
+
* **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.
|
|
3021
|
+
*/
|
|
3022
|
+
const opCreateAssociations = (options) => (options.client ?? client_gen_1.client).post({
|
|
3023
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
3024
|
+
url: '/extensions/roboledger/{graph_id}/operations/create-associations',
|
|
3025
|
+
...options,
|
|
3026
|
+
headers: {
|
|
3027
|
+
'Content-Type': 'application/json',
|
|
3028
|
+
...options.headers
|
|
3029
|
+
}
|
|
3030
|
+
});
|
|
3031
|
+
exports.opCreateAssociations = opCreateAssociations;
|
|
3032
|
+
/**
|
|
3033
|
+
* Update Association
|
|
3034
|
+
*
|
|
3035
|
+
* Update mutable fields on an association. `from_element_id`, `to_element_id`, `association_type`, and `structure_id` are immutable — delete and recreate instead.
|
|
3036
|
+
*
|
|
3037
|
+
* **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.
|
|
3038
|
+
*/
|
|
3039
|
+
const opUpdateAssociation = (options) => (options.client ?? client_gen_1.client).post({
|
|
3040
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
3041
|
+
url: '/extensions/roboledger/{graph_id}/operations/update-association',
|
|
3042
|
+
...options,
|
|
3043
|
+
headers: {
|
|
3044
|
+
'Content-Type': 'application/json',
|
|
3045
|
+
...options.headers
|
|
3046
|
+
}
|
|
3047
|
+
});
|
|
3048
|
+
exports.opUpdateAssociation = opUpdateAssociation;
|
|
3049
|
+
/**
|
|
3050
|
+
* Delete Association
|
|
3051
|
+
*
|
|
3052
|
+
* Hard-delete an association. Generalizes delete-mapping-association to all association types (presentation, calculation, mapping).
|
|
3053
|
+
*
|
|
3054
|
+
* **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.
|
|
3055
|
+
*/
|
|
3056
|
+
const opDeleteAssociation = (options) => (options.client ?? client_gen_1.client).post({
|
|
3057
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
3058
|
+
url: '/extensions/roboledger/{graph_id}/operations/delete-association',
|
|
3059
|
+
...options,
|
|
3060
|
+
headers: {
|
|
3061
|
+
'Content-Type': 'application/json',
|
|
3062
|
+
...options.headers
|
|
3063
|
+
}
|
|
3064
|
+
});
|
|
3065
|
+
exports.opDeleteAssociation = opDeleteAssociation;
|
|
3066
|
+
/**
|
|
3067
|
+
* Create Journal Entry
|
|
3068
|
+
*
|
|
3069
|
+
* Create a new draft journal entry with balanced line items. Enforces DR=CR at the validation layer. Entries are always created as drafts; posting happens via close-period or a future per-entry post op.
|
|
3070
|
+
*
|
|
3071
|
+
* **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.
|
|
3072
|
+
*/
|
|
3073
|
+
const opCreateJournalEntry = (options) => (options.client ?? client_gen_1.client).post({
|
|
3074
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
3075
|
+
url: '/extensions/roboledger/{graph_id}/operations/create-journal-entry',
|
|
3076
|
+
...options,
|
|
3077
|
+
headers: {
|
|
3078
|
+
'Content-Type': 'application/json',
|
|
3079
|
+
...options.headers
|
|
3080
|
+
}
|
|
3081
|
+
});
|
|
3082
|
+
exports.opCreateJournalEntry = opCreateJournalEntry;
|
|
3083
|
+
/**
|
|
3084
|
+
* Update Journal Entry
|
|
3085
|
+
*
|
|
3086
|
+
* Update a draft journal entry. Posted entries are immutable and must be corrected via reverse-journal-entry. If line_items is provided, existing line items are replaced atomically and the new set must balance.
|
|
3087
|
+
*
|
|
3088
|
+
* **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.
|
|
3089
|
+
*/
|
|
3090
|
+
const opUpdateJournalEntry = (options) => (options.client ?? client_gen_1.client).post({
|
|
3091
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
3092
|
+
url: '/extensions/roboledger/{graph_id}/operations/update-journal-entry',
|
|
3093
|
+
...options,
|
|
3094
|
+
headers: {
|
|
3095
|
+
'Content-Type': 'application/json',
|
|
3096
|
+
...options.headers
|
|
3097
|
+
}
|
|
3098
|
+
});
|
|
3099
|
+
exports.opUpdateJournalEntry = opUpdateJournalEntry;
|
|
3100
|
+
/**
|
|
3101
|
+
* Delete Journal Entry
|
|
3102
|
+
*
|
|
3103
|
+
* Hard-delete a draft journal entry. Posted entries are immutable and must be reversed instead.
|
|
3104
|
+
*
|
|
3105
|
+
* **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.
|
|
3106
|
+
*/
|
|
3107
|
+
const opDeleteJournalEntry = (options) => (options.client ?? client_gen_1.client).post({
|
|
3108
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
3109
|
+
url: '/extensions/roboledger/{graph_id}/operations/delete-journal-entry',
|
|
3110
|
+
...options,
|
|
3111
|
+
headers: {
|
|
3112
|
+
'Content-Type': 'application/json',
|
|
3113
|
+
...options.headers
|
|
3114
|
+
}
|
|
3115
|
+
});
|
|
3116
|
+
exports.opDeleteJournalEntry = opDeleteJournalEntry;
|
|
3117
|
+
/**
|
|
3118
|
+
* Reverse Journal Entry
|
|
3119
|
+
*
|
|
3120
|
+
* Reverse a posted journal entry by creating a new offsetting entry (debits ↔ credits) and marking the original as status='reversed'. Both entries stay in the ledger — the audit trail shows original + reversal side by side.
|
|
3121
|
+
*
|
|
3122
|
+
* **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.
|
|
3123
|
+
*/
|
|
3124
|
+
const opReverseJournalEntry = (options) => (options.client ?? client_gen_1.client).post({
|
|
3125
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
3126
|
+
url: '/extensions/roboledger/{graph_id}/operations/reverse-journal-entry',
|
|
3127
|
+
...options,
|
|
3128
|
+
headers: {
|
|
3129
|
+
'Content-Type': 'application/json',
|
|
3130
|
+
...options.headers
|
|
3131
|
+
}
|
|
3132
|
+
});
|
|
3133
|
+
exports.opReverseJournalEntry = opReverseJournalEntry;
|
|
3134
|
+
/**
|
|
3135
|
+
* Update Schedule
|
|
3136
|
+
*
|
|
3137
|
+
* Update mutable fields on a schedule: name, entry_template, schedule_metadata. Period range and monthly_amount are NOT editable — use truncate-schedule + create-schedule instead.
|
|
3138
|
+
*
|
|
3139
|
+
* **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.
|
|
3140
|
+
*/
|
|
3141
|
+
const opUpdateSchedule = (options) => (options.client ?? client_gen_1.client).post({
|
|
3142
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
3143
|
+
url: '/extensions/roboledger/{graph_id}/operations/update-schedule',
|
|
3144
|
+
...options,
|
|
3145
|
+
headers: {
|
|
3146
|
+
'Content-Type': 'application/json',
|
|
3147
|
+
...options.headers
|
|
3148
|
+
}
|
|
3149
|
+
});
|
|
3150
|
+
exports.opUpdateSchedule = opUpdateSchedule;
|
|
3151
|
+
/**
|
|
3152
|
+
* Delete Schedule
|
|
3153
|
+
*
|
|
3154
|
+
* Permanently delete a schedule, cascading through facts and associations. For ending a schedule early without removing history, use truncate-schedule instead.
|
|
3155
|
+
*
|
|
3156
|
+
* **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.
|
|
3157
|
+
*/
|
|
3158
|
+
const opDeleteSchedule = (options) => (options.client ?? client_gen_1.client).post({
|
|
3159
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
3160
|
+
url: '/extensions/roboledger/{graph_id}/operations/delete-schedule',
|
|
3161
|
+
...options,
|
|
3162
|
+
headers: {
|
|
3163
|
+
'Content-Type': 'application/json',
|
|
3164
|
+
...options.headers
|
|
3165
|
+
}
|
|
3166
|
+
});
|
|
3167
|
+
exports.opDeleteSchedule = opDeleteSchedule;
|
|
3071
3168
|
/**
|
|
3072
3169
|
* Auto-Map Elements via AI (async)
|
|
3073
3170
|
*
|
|
@@ -3083,6 +3180,8 @@ exports.opDeleteMappingAssociation = opDeleteMappingAssociation;
|
|
|
3083
3180
|
* - ≥0.90: auto-approved mapping
|
|
3084
3181
|
* - 0.70-0.89: flagged for review
|
|
3085
3182
|
* - <0.70: skipped (left unmapped)
|
|
3183
|
+
*
|
|
3184
|
+
* **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.
|
|
3086
3185
|
*/
|
|
3087
3186
|
const opAutoMapElements = (options) => (options.client ?? client_gen_1.client).post({
|
|
3088
3187
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3098,6 +3197,8 @@ exports.opAutoMapElements = opAutoMapElements;
|
|
|
3098
3197
|
* Create Report
|
|
3099
3198
|
*
|
|
3100
3199
|
* Create a report definition, generate facts, and mark as published.
|
|
3200
|
+
*
|
|
3201
|
+
* **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.
|
|
3101
3202
|
*/
|
|
3102
3203
|
const opCreateReport = (options) => (options.client ?? client_gen_1.client).post({
|
|
3103
3204
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3113,6 +3214,8 @@ exports.opCreateReport = opCreateReport;
|
|
|
3113
3214
|
* Regenerate Report
|
|
3114
3215
|
*
|
|
3115
3216
|
* Regenerate a report with new period dates.
|
|
3217
|
+
*
|
|
3218
|
+
* **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.
|
|
3116
3219
|
*/
|
|
3117
3220
|
const opRegenerateReport = (options) => (options.client ?? client_gen_1.client).post({
|
|
3118
3221
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3128,6 +3231,8 @@ exports.opRegenerateReport = opRegenerateReport;
|
|
|
3128
3231
|
* Delete Report
|
|
3129
3232
|
*
|
|
3130
3233
|
* Delete a report definition and its facts.
|
|
3234
|
+
*
|
|
3235
|
+
* **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.
|
|
3131
3236
|
*/
|
|
3132
3237
|
const opDeleteReport = (options) => (options.client ?? client_gen_1.client).post({
|
|
3133
3238
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3143,6 +3248,8 @@ exports.opDeleteReport = opDeleteReport;
|
|
|
3143
3248
|
* Share Report
|
|
3144
3249
|
*
|
|
3145
3250
|
* Share a published report to a publish list's members.
|
|
3251
|
+
*
|
|
3252
|
+
* **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.
|
|
3146
3253
|
*/
|
|
3147
3254
|
const opShareReport = (options) => (options.client ?? client_gen_1.client).post({
|
|
3148
3255
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3158,6 +3265,8 @@ exports.opShareReport = opShareReport;
|
|
|
3158
3265
|
* Create Publish List
|
|
3159
3266
|
*
|
|
3160
3267
|
* Create a new publish list.
|
|
3268
|
+
*
|
|
3269
|
+
* **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.
|
|
3161
3270
|
*/
|
|
3162
3271
|
const opCreatePublishList = (options) => (options.client ?? client_gen_1.client).post({
|
|
3163
3272
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3173,6 +3282,8 @@ exports.opCreatePublishList = opCreatePublishList;
|
|
|
3173
3282
|
* Update Publish List
|
|
3174
3283
|
*
|
|
3175
3284
|
* Update a publish list's name / description.
|
|
3285
|
+
*
|
|
3286
|
+
* **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.
|
|
3176
3287
|
*/
|
|
3177
3288
|
const opUpdatePublishList = (options) => (options.client ?? client_gen_1.client).post({
|
|
3178
3289
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3188,6 +3299,8 @@ exports.opUpdatePublishList = opUpdatePublishList;
|
|
|
3188
3299
|
* Delete Publish List
|
|
3189
3300
|
*
|
|
3190
3301
|
* Delete a publish list.
|
|
3302
|
+
*
|
|
3303
|
+
* **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.
|
|
3191
3304
|
*/
|
|
3192
3305
|
const opDeletePublishList = (options) => (options.client ?? client_gen_1.client).post({
|
|
3193
3306
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3203,6 +3316,8 @@ exports.opDeletePublishList = opDeletePublishList;
|
|
|
3203
3316
|
* Add Members to Publish List
|
|
3204
3317
|
*
|
|
3205
3318
|
* Add target graphs as members of a publish list.
|
|
3319
|
+
*
|
|
3320
|
+
* **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.
|
|
3206
3321
|
*/
|
|
3207
3322
|
const opAddPublishListMembers = (options) => (options.client ?? client_gen_1.client).post({
|
|
3208
3323
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3218,6 +3333,8 @@ exports.opAddPublishListMembers = opAddPublishListMembers;
|
|
|
3218
3333
|
* Remove Member from Publish List
|
|
3219
3334
|
*
|
|
3220
3335
|
* Remove a target graph from a publish list.
|
|
3336
|
+
*
|
|
3337
|
+
* **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.
|
|
3221
3338
|
*/
|
|
3222
3339
|
const opRemovePublishListMember = (options) => (options.client ?? client_gen_1.client).post({
|
|
3223
3340
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3243,6 +3360,8 @@ exports.opRemovePublishListMember = opRemovePublishListMember;
|
|
|
3243
3360
|
* not the extensions OLTP database. The same operation works for
|
|
3244
3361
|
* roboledger tenant graphs (post-materialization) and the SEC shared
|
|
3245
3362
|
* repository (which uses the same XBRL hypercube schema).
|
|
3363
|
+
*
|
|
3364
|
+
* **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.
|
|
3246
3365
|
*/
|
|
3247
3366
|
const opBuildFactGrid = (options) => (options.client ?? client_gen_1.client).post({
|
|
3248
3367
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3256,6 +3375,10 @@ const opBuildFactGrid = (options) => (options.client ?? client_gen_1.client).pos
|
|
|
3256
3375
|
exports.opBuildFactGrid = opBuildFactGrid;
|
|
3257
3376
|
/**
|
|
3258
3377
|
* Create Portfolio
|
|
3378
|
+
*
|
|
3379
|
+
*
|
|
3380
|
+
*
|
|
3381
|
+
* **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.
|
|
3259
3382
|
*/
|
|
3260
3383
|
const opCreatePortfolio = (options) => (options.client ?? client_gen_1.client).post({
|
|
3261
3384
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3269,6 +3392,10 @@ const opCreatePortfolio = (options) => (options.client ?? client_gen_1.client).p
|
|
|
3269
3392
|
exports.opCreatePortfolio = opCreatePortfolio;
|
|
3270
3393
|
/**
|
|
3271
3394
|
* Update Portfolio
|
|
3395
|
+
*
|
|
3396
|
+
*
|
|
3397
|
+
*
|
|
3398
|
+
* **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.
|
|
3272
3399
|
*/
|
|
3273
3400
|
const opUpdatePortfolio = (options) => (options.client ?? client_gen_1.client).post({
|
|
3274
3401
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3282,6 +3409,10 @@ const opUpdatePortfolio = (options) => (options.client ?? client_gen_1.client).p
|
|
|
3282
3409
|
exports.opUpdatePortfolio = opUpdatePortfolio;
|
|
3283
3410
|
/**
|
|
3284
3411
|
* Delete Portfolio
|
|
3412
|
+
*
|
|
3413
|
+
*
|
|
3414
|
+
*
|
|
3415
|
+
* **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.
|
|
3285
3416
|
*/
|
|
3286
3417
|
const opDeletePortfolio = (options) => (options.client ?? client_gen_1.client).post({
|
|
3287
3418
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3295,6 +3426,10 @@ const opDeletePortfolio = (options) => (options.client ?? client_gen_1.client).p
|
|
|
3295
3426
|
exports.opDeletePortfolio = opDeletePortfolio;
|
|
3296
3427
|
/**
|
|
3297
3428
|
* Create Security
|
|
3429
|
+
*
|
|
3430
|
+
*
|
|
3431
|
+
*
|
|
3432
|
+
* **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.
|
|
3298
3433
|
*/
|
|
3299
3434
|
const opCreateSecurity = (options) => (options.client ?? client_gen_1.client).post({
|
|
3300
3435
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3308,6 +3443,10 @@ const opCreateSecurity = (options) => (options.client ?? client_gen_1.client).po
|
|
|
3308
3443
|
exports.opCreateSecurity = opCreateSecurity;
|
|
3309
3444
|
/**
|
|
3310
3445
|
* Update Security
|
|
3446
|
+
*
|
|
3447
|
+
*
|
|
3448
|
+
*
|
|
3449
|
+
* **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.
|
|
3311
3450
|
*/
|
|
3312
3451
|
const opUpdateSecurity = (options) => (options.client ?? client_gen_1.client).post({
|
|
3313
3452
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3321,6 +3460,10 @@ const opUpdateSecurity = (options) => (options.client ?? client_gen_1.client).po
|
|
|
3321
3460
|
exports.opUpdateSecurity = opUpdateSecurity;
|
|
3322
3461
|
/**
|
|
3323
3462
|
* Delete Security
|
|
3463
|
+
*
|
|
3464
|
+
*
|
|
3465
|
+
*
|
|
3466
|
+
* **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.
|
|
3324
3467
|
*/
|
|
3325
3468
|
const opDeleteSecurity = (options) => (options.client ?? client_gen_1.client).post({
|
|
3326
3469
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3334,6 +3477,10 @@ const opDeleteSecurity = (options) => (options.client ?? client_gen_1.client).po
|
|
|
3334
3477
|
exports.opDeleteSecurity = opDeleteSecurity;
|
|
3335
3478
|
/**
|
|
3336
3479
|
* Create Position
|
|
3480
|
+
*
|
|
3481
|
+
*
|
|
3482
|
+
*
|
|
3483
|
+
* **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.
|
|
3337
3484
|
*/
|
|
3338
3485
|
const opCreatePosition = (options) => (options.client ?? client_gen_1.client).post({
|
|
3339
3486
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3347,6 +3494,10 @@ const opCreatePosition = (options) => (options.client ?? client_gen_1.client).po
|
|
|
3347
3494
|
exports.opCreatePosition = opCreatePosition;
|
|
3348
3495
|
/**
|
|
3349
3496
|
* Update Position
|
|
3497
|
+
*
|
|
3498
|
+
*
|
|
3499
|
+
*
|
|
3500
|
+
* **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.
|
|
3350
3501
|
*/
|
|
3351
3502
|
const opUpdatePosition = (options) => (options.client ?? client_gen_1.client).post({
|
|
3352
3503
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3360,6 +3511,10 @@ const opUpdatePosition = (options) => (options.client ?? client_gen_1.client).po
|
|
|
3360
3511
|
exports.opUpdatePosition = opUpdatePosition;
|
|
3361
3512
|
/**
|
|
3362
3513
|
* Delete Position
|
|
3514
|
+
*
|
|
3515
|
+
*
|
|
3516
|
+
*
|
|
3517
|
+
* **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.
|
|
3363
3518
|
*/
|
|
3364
3519
|
const opDeletePosition = (options) => (options.client ?? client_gen_1.client).post({
|
|
3365
3520
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|