@robosystems/client 0.3.1 → 0.3.3
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 +272 -274
- package/sdk/sdk.gen.js +468 -312
- package/sdk/sdk.gen.ts +464 -309
- package/sdk/types.gen.d.ts +2962 -440
- package/sdk/types.gen.ts +3058 -430
- package/sdk.gen.d.ts +272 -274
- package/sdk.gen.js +468 -312
- package/sdk.gen.ts +464 -309
- package/types.gen.d.ts +2962 -440
- package/types.gen.ts +3058 -430
- 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/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,110 @@ 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).
|
|
1754
|
+
* Delete Subgraph
|
|
2005
1755
|
*
|
|
2006
|
-
*
|
|
2007
|
-
* staging tables. It automatically discovers all tables, ingests them in the correct
|
|
2008
|
-
* order (nodes before relationships), and clears the staleness flag.
|
|
1756
|
+
* Delete a subgraph database.
|
|
2009
1757
|
*
|
|
2010
|
-
* **
|
|
2011
|
-
|
|
2012
|
-
|
|
2013
|
-
|
|
2014
|
-
|
|
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
|
|
2015
1772
|
*
|
|
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
|
|
1773
|
+
* Create a backup of the graph database (async).
|
|
2022
1774
|
*
|
|
2023
|
-
* **
|
|
2024
|
-
|
|
2025
|
-
|
|
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
|
|
2026
1789
|
*
|
|
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
|
|
1790
|
+
* Restore a graph database from an encrypted backup.
|
|
2035
1791
|
*
|
|
2036
|
-
*
|
|
2037
|
-
*
|
|
2038
|
-
* ensure referential integrity.
|
|
1792
|
+
* Blocked for entity graphs — OLTP is the source of truth, use
|
|
1793
|
+
* the materialize operation instead.
|
|
2039
1794
|
*
|
|
2040
|
-
* **
|
|
2041
|
-
|
|
2042
|
-
|
|
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
|
|
2043
1809
|
*
|
|
2044
|
-
*
|
|
2045
|
-
* Only one materialization can run per graph at a time. If another materialization is in progress,
|
|
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.
|
|
1810
|
+
* Change the infrastructure tier on a graph (async EBS migration).
|
|
2048
1811
|
*
|
|
2049
|
-
* **
|
|
2050
|
-
|
|
2051
|
-
|
|
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.
|
|
1813
|
+
*/
|
|
1814
|
+
const opUpgradeTier = (options) => (options.client ?? client_gen_1.client).post({
|
|
1815
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1816
|
+
url: '/v1/graphs/{graph_id}/operations/upgrade-tier',
|
|
1817
|
+
...options,
|
|
1818
|
+
headers: {
|
|
1819
|
+
'Content-Type': 'application/json',
|
|
1820
|
+
...options.headers
|
|
1821
|
+
}
|
|
1822
|
+
});
|
|
1823
|
+
exports.opUpgradeTier = opUpgradeTier;
|
|
1824
|
+
/**
|
|
1825
|
+
* Materialize Graph
|
|
2052
1826
|
*
|
|
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.
|
|
1827
|
+
* Materialize graph from staging tables or extensions OLTP.
|
|
2056
1828
|
*
|
|
2057
|
-
* **
|
|
2058
|
-
* Materialization is included - no credit consumption
|
|
1829
|
+
* **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
1830
|
*/
|
|
2060
|
-
const
|
|
1831
|
+
const opMaterialize = (options) => (options.client ?? client_gen_1.client).post({
|
|
2061
1832
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2062
|
-
url: '/v1/graphs/{graph_id}/materialize',
|
|
1833
|
+
url: '/v1/graphs/{graph_id}/operations/materialize',
|
|
2063
1834
|
...options,
|
|
2064
1835
|
headers: {
|
|
2065
1836
|
'Content-Type': 'application/json',
|
|
2066
1837
|
...options.headers
|
|
2067
1838
|
}
|
|
2068
1839
|
});
|
|
2069
|
-
exports.
|
|
1840
|
+
exports.opMaterialize = opMaterialize;
|
|
2070
1841
|
/**
|
|
2071
1842
|
* List Files in Graph
|
|
2072
1843
|
*
|
|
@@ -2857,6 +2628,12 @@ const getCheckoutStatus = (options) => (options.client ?? client_gen_1.client).g
|
|
|
2857
2628
|
exports.getCheckoutStatus = getCheckoutStatus;
|
|
2858
2629
|
/**
|
|
2859
2630
|
* Handle Http Get
|
|
2631
|
+
*
|
|
2632
|
+
*
|
|
2633
|
+
*
|
|
2634
|
+
* **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`.
|
|
2635
|
+
*
|
|
2636
|
+
* **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
2637
|
*/
|
|
2861
2638
|
const handleHttpGetExtensionsGraphIdGraphqlGet = (options) => (options.client ?? client_gen_1.client).get({
|
|
2862
2639
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -2866,6 +2643,12 @@ const handleHttpGetExtensionsGraphIdGraphqlGet = (options) => (options.client ??
|
|
|
2866
2643
|
exports.handleHttpGetExtensionsGraphIdGraphqlGet = handleHttpGetExtensionsGraphIdGraphqlGet;
|
|
2867
2644
|
/**
|
|
2868
2645
|
* Handle Http Post
|
|
2646
|
+
*
|
|
2647
|
+
*
|
|
2648
|
+
*
|
|
2649
|
+
* **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`.
|
|
2650
|
+
*
|
|
2651
|
+
* **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
2652
|
*/
|
|
2870
2653
|
const handleHttpPostExtensionsGraphIdGraphqlPost = (options) => (options.client ?? client_gen_1.client).post({
|
|
2871
2654
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -2877,6 +2660,8 @@ exports.handleHttpPostExtensionsGraphIdGraphqlPost = handleHttpPostExtensionsGra
|
|
|
2877
2660
|
* Update Entity
|
|
2878
2661
|
*
|
|
2879
2662
|
* Update entity details. Only provided (non-null) fields are updated.
|
|
2663
|
+
*
|
|
2664
|
+
* **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
2665
|
*/
|
|
2881
2666
|
const opUpdateEntity = (options) => (options.client ?? client_gen_1.client).post({
|
|
2882
2667
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -2892,6 +2677,8 @@ exports.opUpdateEntity = opUpdateEntity;
|
|
|
2892
2677
|
* Initialize Ledger
|
|
2893
2678
|
*
|
|
2894
2679
|
* One-time ledger initialization — create fiscal calendar + seed periods.
|
|
2680
|
+
*
|
|
2681
|
+
* **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
2682
|
*/
|
|
2896
2683
|
const opInitializeLedger = (options) => (options.client ?? client_gen_1.client).post({
|
|
2897
2684
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -2907,6 +2694,8 @@ exports.opInitializeLedger = opInitializeLedger;
|
|
|
2907
2694
|
* Set Close Target
|
|
2908
2695
|
*
|
|
2909
2696
|
* Set the user-controlled close target (YYYY-MM).
|
|
2697
|
+
*
|
|
2698
|
+
* **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
2699
|
*/
|
|
2911
2700
|
const opSetCloseTarget = (options) => (options.client ?? client_gen_1.client).post({
|
|
2912
2701
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -2922,6 +2711,8 @@ exports.opSetCloseTarget = opSetCloseTarget;
|
|
|
2922
2711
|
* Close Fiscal Period
|
|
2923
2712
|
*
|
|
2924
2713
|
* Close a fiscal period — the final commit action.
|
|
2714
|
+
*
|
|
2715
|
+
* **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
2716
|
*/
|
|
2926
2717
|
const opClosePeriod = (options) => (options.client ?? client_gen_1.client).post({
|
|
2927
2718
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -2937,6 +2728,8 @@ exports.opClosePeriod = opClosePeriod;
|
|
|
2937
2728
|
* Reopen Fiscal Period
|
|
2938
2729
|
*
|
|
2939
2730
|
* Reopen a closed fiscal period — decrements `closed_through`.
|
|
2731
|
+
*
|
|
2732
|
+
* **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
2733
|
*/
|
|
2941
2734
|
const opReopenPeriod = (options) => (options.client ?? client_gen_1.client).post({
|
|
2942
2735
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -2952,6 +2745,8 @@ exports.opReopenPeriod = opReopenPeriod;
|
|
|
2952
2745
|
* Create Schedule
|
|
2953
2746
|
*
|
|
2954
2747
|
* Create a schedule with pre-generated monthly facts.
|
|
2748
|
+
*
|
|
2749
|
+
* **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
2750
|
*/
|
|
2956
2751
|
const opCreateSchedule = (options) => (options.client ?? client_gen_1.client).post({
|
|
2957
2752
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -2967,6 +2762,8 @@ exports.opCreateSchedule = opCreateSchedule;
|
|
|
2967
2762
|
* Truncate Schedule (End Early)
|
|
2968
2763
|
*
|
|
2969
2764
|
* End a schedule early — delete forward facts + stale drafts.
|
|
2765
|
+
*
|
|
2766
|
+
* **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
2767
|
*/
|
|
2971
2768
|
const opTruncateSchedule = (options) => (options.client ?? client_gen_1.client).post({
|
|
2972
2769
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -2982,6 +2779,8 @@ exports.opTruncateSchedule = opTruncateSchedule;
|
|
|
2982
2779
|
* Create Closing Entry
|
|
2983
2780
|
*
|
|
2984
2781
|
* Create a draft closing entry from a schedule's facts for a period.
|
|
2782
|
+
*
|
|
2783
|
+
* **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
2784
|
*/
|
|
2986
2785
|
const opCreateClosingEntry = (options) => (options.client ?? client_gen_1.client).post({
|
|
2987
2786
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -2997,6 +2796,8 @@ exports.opCreateClosingEntry = opCreateClosingEntry;
|
|
|
2997
2796
|
* Create Manual Closing Entry
|
|
2998
2797
|
*
|
|
2999
2798
|
* Create a manual (non-schedule) draft closing entry.
|
|
2799
|
+
*
|
|
2800
|
+
* **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
2801
|
*/
|
|
3001
2802
|
const opCreateManualClosingEntry = (options) => (options.client ?? client_gen_1.client).post({
|
|
3002
2803
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3012,6 +2813,8 @@ exports.opCreateManualClosingEntry = opCreateManualClosingEntry;
|
|
|
3012
2813
|
* Create Taxonomy
|
|
3013
2814
|
*
|
|
3014
2815
|
* Create a new taxonomy definition.
|
|
2816
|
+
*
|
|
2817
|
+
* **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
2818
|
*/
|
|
3016
2819
|
const opCreateTaxonomy = (options) => (options.client ?? client_gen_1.client).post({
|
|
3017
2820
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3027,6 +2830,8 @@ exports.opCreateTaxonomy = opCreateTaxonomy;
|
|
|
3027
2830
|
* Create Structure
|
|
3028
2831
|
*
|
|
3029
2832
|
* Create a new structure (statement, mapping, schedule, etc.).
|
|
2833
|
+
*
|
|
2834
|
+
* **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
2835
|
*/
|
|
3031
2836
|
const opCreateStructure = (options) => (options.client ?? client_gen_1.client).post({
|
|
3032
2837
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3042,6 +2847,8 @@ exports.opCreateStructure = opCreateStructure;
|
|
|
3042
2847
|
* Create Mapping Association
|
|
3043
2848
|
*
|
|
3044
2849
|
* Add a mapping association (CoA element → reporting concept).
|
|
2850
|
+
*
|
|
2851
|
+
* **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
2852
|
*/
|
|
3046
2853
|
const opCreateMappingAssociation = (options) => (options.client ?? client_gen_1.client).post({
|
|
3047
2854
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3057,6 +2864,8 @@ exports.opCreateMappingAssociation = opCreateMappingAssociation;
|
|
|
3057
2864
|
* Delete Mapping Association
|
|
3058
2865
|
*
|
|
3059
2866
|
* Remove a mapping association.
|
|
2867
|
+
*
|
|
2868
|
+
* **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
2869
|
*/
|
|
3061
2870
|
const opDeleteMappingAssociation = (options) => (options.client ?? client_gen_1.client).post({
|
|
3062
2871
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3068,6 +2877,295 @@ const opDeleteMappingAssociation = (options) => (options.client ?? client_gen_1.
|
|
|
3068
2877
|
}
|
|
3069
2878
|
});
|
|
3070
2879
|
exports.opDeleteMappingAssociation = opDeleteMappingAssociation;
|
|
2880
|
+
/**
|
|
2881
|
+
* Update Taxonomy
|
|
2882
|
+
*
|
|
2883
|
+
* Update mutable fields on a taxonomy. `taxonomy_type` is immutable.
|
|
2884
|
+
*
|
|
2885
|
+
* **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.
|
|
2886
|
+
*/
|
|
2887
|
+
const opUpdateTaxonomy = (options) => (options.client ?? client_gen_1.client).post({
|
|
2888
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2889
|
+
url: '/extensions/roboledger/{graph_id}/operations/update-taxonomy',
|
|
2890
|
+
...options,
|
|
2891
|
+
headers: {
|
|
2892
|
+
'Content-Type': 'application/json',
|
|
2893
|
+
...options.headers
|
|
2894
|
+
}
|
|
2895
|
+
});
|
|
2896
|
+
exports.opUpdateTaxonomy = opUpdateTaxonomy;
|
|
2897
|
+
/**
|
|
2898
|
+
* Delete Taxonomy
|
|
2899
|
+
*
|
|
2900
|
+
* Soft-delete a taxonomy (sets `is_active=false`). Historical references remain valid.
|
|
2901
|
+
*
|
|
2902
|
+
* **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.
|
|
2903
|
+
*/
|
|
2904
|
+
const opDeleteTaxonomy = (options) => (options.client ?? client_gen_1.client).post({
|
|
2905
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2906
|
+
url: '/extensions/roboledger/{graph_id}/operations/delete-taxonomy',
|
|
2907
|
+
...options,
|
|
2908
|
+
headers: {
|
|
2909
|
+
'Content-Type': 'application/json',
|
|
2910
|
+
...options.headers
|
|
2911
|
+
}
|
|
2912
|
+
});
|
|
2913
|
+
exports.opDeleteTaxonomy = opDeleteTaxonomy;
|
|
2914
|
+
/**
|
|
2915
|
+
* Link Entity to Taxonomy
|
|
2916
|
+
*
|
|
2917
|
+
* 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.
|
|
2918
|
+
*
|
|
2919
|
+
* **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.
|
|
2920
|
+
*/
|
|
2921
|
+
const opLinkEntityTaxonomy = (options) => (options.client ?? client_gen_1.client).post({
|
|
2922
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2923
|
+
url: '/extensions/roboledger/{graph_id}/operations/link-entity-taxonomy',
|
|
2924
|
+
...options,
|
|
2925
|
+
headers: {
|
|
2926
|
+
'Content-Type': 'application/json',
|
|
2927
|
+
...options.headers
|
|
2928
|
+
}
|
|
2929
|
+
});
|
|
2930
|
+
exports.opLinkEntityTaxonomy = opLinkEntityTaxonomy;
|
|
2931
|
+
/**
|
|
2932
|
+
* Update Structure
|
|
2933
|
+
*
|
|
2934
|
+
* Update mutable fields on a structure. `structure_type` and `taxonomy_id` are immutable.
|
|
2935
|
+
*
|
|
2936
|
+
* **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.
|
|
2937
|
+
*/
|
|
2938
|
+
const opUpdateStructure = (options) => (options.client ?? client_gen_1.client).post({
|
|
2939
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2940
|
+
url: '/extensions/roboledger/{graph_id}/operations/update-structure',
|
|
2941
|
+
...options,
|
|
2942
|
+
headers: {
|
|
2943
|
+
'Content-Type': 'application/json',
|
|
2944
|
+
...options.headers
|
|
2945
|
+
}
|
|
2946
|
+
});
|
|
2947
|
+
exports.opUpdateStructure = opUpdateStructure;
|
|
2948
|
+
/**
|
|
2949
|
+
* Delete Structure
|
|
2950
|
+
*
|
|
2951
|
+
* Soft-delete a structure (sets `is_active=false`). Associations referencing it are effectively orphaned.
|
|
2952
|
+
*
|
|
2953
|
+
* **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.
|
|
2954
|
+
*/
|
|
2955
|
+
const opDeleteStructure = (options) => (options.client ?? client_gen_1.client).post({
|
|
2956
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2957
|
+
url: '/extensions/roboledger/{graph_id}/operations/delete-structure',
|
|
2958
|
+
...options,
|
|
2959
|
+
headers: {
|
|
2960
|
+
'Content-Type': 'application/json',
|
|
2961
|
+
...options.headers
|
|
2962
|
+
}
|
|
2963
|
+
});
|
|
2964
|
+
exports.opDeleteStructure = opDeleteStructure;
|
|
2965
|
+
/**
|
|
2966
|
+
* Create Element
|
|
2967
|
+
*
|
|
2968
|
+
* Create an element within a taxonomy. For chart-of-accounts taxonomies this is how native accounts are added.
|
|
2969
|
+
*
|
|
2970
|
+
* **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.
|
|
2971
|
+
*/
|
|
2972
|
+
const opCreateElement = (options) => (options.client ?? client_gen_1.client).post({
|
|
2973
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2974
|
+
url: '/extensions/roboledger/{graph_id}/operations/create-element',
|
|
2975
|
+
...options,
|
|
2976
|
+
headers: {
|
|
2977
|
+
'Content-Type': 'application/json',
|
|
2978
|
+
...options.headers
|
|
2979
|
+
}
|
|
2980
|
+
});
|
|
2981
|
+
exports.opCreateElement = opCreateElement;
|
|
2982
|
+
/**
|
|
2983
|
+
* Update Element
|
|
2984
|
+
*
|
|
2985
|
+
* Update mutable fields on an element. `taxonomy_id` and `source` are immutable. Reparenting cascades path/depth to descendants.
|
|
2986
|
+
*
|
|
2987
|
+
* **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.
|
|
2988
|
+
*/
|
|
2989
|
+
const opUpdateElement = (options) => (options.client ?? client_gen_1.client).post({
|
|
2990
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2991
|
+
url: '/extensions/roboledger/{graph_id}/operations/update-element',
|
|
2992
|
+
...options,
|
|
2993
|
+
headers: {
|
|
2994
|
+
'Content-Type': 'application/json',
|
|
2995
|
+
...options.headers
|
|
2996
|
+
}
|
|
2997
|
+
});
|
|
2998
|
+
exports.opUpdateElement = opUpdateElement;
|
|
2999
|
+
/**
|
|
3000
|
+
* Delete Element
|
|
3001
|
+
*
|
|
3002
|
+
* Soft-delete an element (sets `is_active=false`). Historical line items referencing it remain valid.
|
|
3003
|
+
*
|
|
3004
|
+
* **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.
|
|
3005
|
+
*/
|
|
3006
|
+
const opDeleteElement = (options) => (options.client ?? client_gen_1.client).post({
|
|
3007
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
3008
|
+
url: '/extensions/roboledger/{graph_id}/operations/delete-element',
|
|
3009
|
+
...options,
|
|
3010
|
+
headers: {
|
|
3011
|
+
'Content-Type': 'application/json',
|
|
3012
|
+
...options.headers
|
|
3013
|
+
}
|
|
3014
|
+
});
|
|
3015
|
+
exports.opDeleteElement = opDeleteElement;
|
|
3016
|
+
/**
|
|
3017
|
+
* Create Associations (Bulk)
|
|
3018
|
+
*
|
|
3019
|
+
* 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.
|
|
3020
|
+
*
|
|
3021
|
+
* **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.
|
|
3022
|
+
*/
|
|
3023
|
+
const opCreateAssociations = (options) => (options.client ?? client_gen_1.client).post({
|
|
3024
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
3025
|
+
url: '/extensions/roboledger/{graph_id}/operations/create-associations',
|
|
3026
|
+
...options,
|
|
3027
|
+
headers: {
|
|
3028
|
+
'Content-Type': 'application/json',
|
|
3029
|
+
...options.headers
|
|
3030
|
+
}
|
|
3031
|
+
});
|
|
3032
|
+
exports.opCreateAssociations = opCreateAssociations;
|
|
3033
|
+
/**
|
|
3034
|
+
* Update Association
|
|
3035
|
+
*
|
|
3036
|
+
* Update mutable fields on an association. `from_element_id`, `to_element_id`, `association_type`, and `structure_id` are immutable — delete and recreate instead.
|
|
3037
|
+
*
|
|
3038
|
+
* **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.
|
|
3039
|
+
*/
|
|
3040
|
+
const opUpdateAssociation = (options) => (options.client ?? client_gen_1.client).post({
|
|
3041
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
3042
|
+
url: '/extensions/roboledger/{graph_id}/operations/update-association',
|
|
3043
|
+
...options,
|
|
3044
|
+
headers: {
|
|
3045
|
+
'Content-Type': 'application/json',
|
|
3046
|
+
...options.headers
|
|
3047
|
+
}
|
|
3048
|
+
});
|
|
3049
|
+
exports.opUpdateAssociation = opUpdateAssociation;
|
|
3050
|
+
/**
|
|
3051
|
+
* Delete Association
|
|
3052
|
+
*
|
|
3053
|
+
* Hard-delete an association. Generalizes delete-mapping-association to all association types (presentation, calculation, mapping).
|
|
3054
|
+
*
|
|
3055
|
+
* **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.
|
|
3056
|
+
*/
|
|
3057
|
+
const opDeleteAssociation = (options) => (options.client ?? client_gen_1.client).post({
|
|
3058
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
3059
|
+
url: '/extensions/roboledger/{graph_id}/operations/delete-association',
|
|
3060
|
+
...options,
|
|
3061
|
+
headers: {
|
|
3062
|
+
'Content-Type': 'application/json',
|
|
3063
|
+
...options.headers
|
|
3064
|
+
}
|
|
3065
|
+
});
|
|
3066
|
+
exports.opDeleteAssociation = opDeleteAssociation;
|
|
3067
|
+
/**
|
|
3068
|
+
* Create Journal Entry
|
|
3069
|
+
*
|
|
3070
|
+
* 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.
|
|
3071
|
+
*
|
|
3072
|
+
* **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.
|
|
3073
|
+
*/
|
|
3074
|
+
const opCreateJournalEntry = (options) => (options.client ?? client_gen_1.client).post({
|
|
3075
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
3076
|
+
url: '/extensions/roboledger/{graph_id}/operations/create-journal-entry',
|
|
3077
|
+
...options,
|
|
3078
|
+
headers: {
|
|
3079
|
+
'Content-Type': 'application/json',
|
|
3080
|
+
...options.headers
|
|
3081
|
+
}
|
|
3082
|
+
});
|
|
3083
|
+
exports.opCreateJournalEntry = opCreateJournalEntry;
|
|
3084
|
+
/**
|
|
3085
|
+
* Update Journal Entry
|
|
3086
|
+
*
|
|
3087
|
+
* 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.
|
|
3088
|
+
*
|
|
3089
|
+
* **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.
|
|
3090
|
+
*/
|
|
3091
|
+
const opUpdateJournalEntry = (options) => (options.client ?? client_gen_1.client).post({
|
|
3092
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
3093
|
+
url: '/extensions/roboledger/{graph_id}/operations/update-journal-entry',
|
|
3094
|
+
...options,
|
|
3095
|
+
headers: {
|
|
3096
|
+
'Content-Type': 'application/json',
|
|
3097
|
+
...options.headers
|
|
3098
|
+
}
|
|
3099
|
+
});
|
|
3100
|
+
exports.opUpdateJournalEntry = opUpdateJournalEntry;
|
|
3101
|
+
/**
|
|
3102
|
+
* Delete Journal Entry
|
|
3103
|
+
*
|
|
3104
|
+
* Hard-delete a draft journal entry. Posted entries are immutable and must be reversed instead.
|
|
3105
|
+
*
|
|
3106
|
+
* **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.
|
|
3107
|
+
*/
|
|
3108
|
+
const opDeleteJournalEntry = (options) => (options.client ?? client_gen_1.client).post({
|
|
3109
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
3110
|
+
url: '/extensions/roboledger/{graph_id}/operations/delete-journal-entry',
|
|
3111
|
+
...options,
|
|
3112
|
+
headers: {
|
|
3113
|
+
'Content-Type': 'application/json',
|
|
3114
|
+
...options.headers
|
|
3115
|
+
}
|
|
3116
|
+
});
|
|
3117
|
+
exports.opDeleteJournalEntry = opDeleteJournalEntry;
|
|
3118
|
+
/**
|
|
3119
|
+
* Reverse Journal Entry
|
|
3120
|
+
*
|
|
3121
|
+
* 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.
|
|
3122
|
+
*
|
|
3123
|
+
* **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.
|
|
3124
|
+
*/
|
|
3125
|
+
const opReverseJournalEntry = (options) => (options.client ?? client_gen_1.client).post({
|
|
3126
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
3127
|
+
url: '/extensions/roboledger/{graph_id}/operations/reverse-journal-entry',
|
|
3128
|
+
...options,
|
|
3129
|
+
headers: {
|
|
3130
|
+
'Content-Type': 'application/json',
|
|
3131
|
+
...options.headers
|
|
3132
|
+
}
|
|
3133
|
+
});
|
|
3134
|
+
exports.opReverseJournalEntry = opReverseJournalEntry;
|
|
3135
|
+
/**
|
|
3136
|
+
* Update Schedule
|
|
3137
|
+
*
|
|
3138
|
+
* 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.
|
|
3139
|
+
*
|
|
3140
|
+
* **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.
|
|
3141
|
+
*/
|
|
3142
|
+
const opUpdateSchedule = (options) => (options.client ?? client_gen_1.client).post({
|
|
3143
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
3144
|
+
url: '/extensions/roboledger/{graph_id}/operations/update-schedule',
|
|
3145
|
+
...options,
|
|
3146
|
+
headers: {
|
|
3147
|
+
'Content-Type': 'application/json',
|
|
3148
|
+
...options.headers
|
|
3149
|
+
}
|
|
3150
|
+
});
|
|
3151
|
+
exports.opUpdateSchedule = opUpdateSchedule;
|
|
3152
|
+
/**
|
|
3153
|
+
* Delete Schedule
|
|
3154
|
+
*
|
|
3155
|
+
* Permanently delete a schedule, cascading through facts and associations. For ending a schedule early without removing history, use truncate-schedule instead.
|
|
3156
|
+
*
|
|
3157
|
+
* **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.
|
|
3158
|
+
*/
|
|
3159
|
+
const opDeleteSchedule = (options) => (options.client ?? client_gen_1.client).post({
|
|
3160
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
3161
|
+
url: '/extensions/roboledger/{graph_id}/operations/delete-schedule',
|
|
3162
|
+
...options,
|
|
3163
|
+
headers: {
|
|
3164
|
+
'Content-Type': 'application/json',
|
|
3165
|
+
...options.headers
|
|
3166
|
+
}
|
|
3167
|
+
});
|
|
3168
|
+
exports.opDeleteSchedule = opDeleteSchedule;
|
|
3071
3169
|
/**
|
|
3072
3170
|
* Auto-Map Elements via AI (async)
|
|
3073
3171
|
*
|
|
@@ -3083,6 +3181,8 @@ exports.opDeleteMappingAssociation = opDeleteMappingAssociation;
|
|
|
3083
3181
|
* - ≥0.90: auto-approved mapping
|
|
3084
3182
|
* - 0.70-0.89: flagged for review
|
|
3085
3183
|
* - <0.70: skipped (left unmapped)
|
|
3184
|
+
*
|
|
3185
|
+
* **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
3186
|
*/
|
|
3087
3187
|
const opAutoMapElements = (options) => (options.client ?? client_gen_1.client).post({
|
|
3088
3188
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3098,6 +3198,8 @@ exports.opAutoMapElements = opAutoMapElements;
|
|
|
3098
3198
|
* Create Report
|
|
3099
3199
|
*
|
|
3100
3200
|
* Create a report definition, generate facts, and mark as published.
|
|
3201
|
+
*
|
|
3202
|
+
* **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
3203
|
*/
|
|
3102
3204
|
const opCreateReport = (options) => (options.client ?? client_gen_1.client).post({
|
|
3103
3205
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3113,6 +3215,8 @@ exports.opCreateReport = opCreateReport;
|
|
|
3113
3215
|
* Regenerate Report
|
|
3114
3216
|
*
|
|
3115
3217
|
* Regenerate a report with new period dates.
|
|
3218
|
+
*
|
|
3219
|
+
* **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
3220
|
*/
|
|
3117
3221
|
const opRegenerateReport = (options) => (options.client ?? client_gen_1.client).post({
|
|
3118
3222
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3128,6 +3232,8 @@ exports.opRegenerateReport = opRegenerateReport;
|
|
|
3128
3232
|
* Delete Report
|
|
3129
3233
|
*
|
|
3130
3234
|
* Delete a report definition and its facts.
|
|
3235
|
+
*
|
|
3236
|
+
* **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
3237
|
*/
|
|
3132
3238
|
const opDeleteReport = (options) => (options.client ?? client_gen_1.client).post({
|
|
3133
3239
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3143,6 +3249,8 @@ exports.opDeleteReport = opDeleteReport;
|
|
|
3143
3249
|
* Share Report
|
|
3144
3250
|
*
|
|
3145
3251
|
* Share a published report to a publish list's members.
|
|
3252
|
+
*
|
|
3253
|
+
* **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
3254
|
*/
|
|
3147
3255
|
const opShareReport = (options) => (options.client ?? client_gen_1.client).post({
|
|
3148
3256
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3158,6 +3266,8 @@ exports.opShareReport = opShareReport;
|
|
|
3158
3266
|
* Create Publish List
|
|
3159
3267
|
*
|
|
3160
3268
|
* Create a new publish list.
|
|
3269
|
+
*
|
|
3270
|
+
* **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
3271
|
*/
|
|
3162
3272
|
const opCreatePublishList = (options) => (options.client ?? client_gen_1.client).post({
|
|
3163
3273
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3173,6 +3283,8 @@ exports.opCreatePublishList = opCreatePublishList;
|
|
|
3173
3283
|
* Update Publish List
|
|
3174
3284
|
*
|
|
3175
3285
|
* Update a publish list's name / description.
|
|
3286
|
+
*
|
|
3287
|
+
* **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
3288
|
*/
|
|
3177
3289
|
const opUpdatePublishList = (options) => (options.client ?? client_gen_1.client).post({
|
|
3178
3290
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3188,6 +3300,8 @@ exports.opUpdatePublishList = opUpdatePublishList;
|
|
|
3188
3300
|
* Delete Publish List
|
|
3189
3301
|
*
|
|
3190
3302
|
* Delete a publish list.
|
|
3303
|
+
*
|
|
3304
|
+
* **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
3305
|
*/
|
|
3192
3306
|
const opDeletePublishList = (options) => (options.client ?? client_gen_1.client).post({
|
|
3193
3307
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3203,6 +3317,8 @@ exports.opDeletePublishList = opDeletePublishList;
|
|
|
3203
3317
|
* Add Members to Publish List
|
|
3204
3318
|
*
|
|
3205
3319
|
* Add target graphs as members of a publish list.
|
|
3320
|
+
*
|
|
3321
|
+
* **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
3322
|
*/
|
|
3207
3323
|
const opAddPublishListMembers = (options) => (options.client ?? client_gen_1.client).post({
|
|
3208
3324
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3218,6 +3334,8 @@ exports.opAddPublishListMembers = opAddPublishListMembers;
|
|
|
3218
3334
|
* Remove Member from Publish List
|
|
3219
3335
|
*
|
|
3220
3336
|
* Remove a target graph from a publish list.
|
|
3337
|
+
*
|
|
3338
|
+
* **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
3339
|
*/
|
|
3222
3340
|
const opRemovePublishListMember = (options) => (options.client ?? client_gen_1.client).post({
|
|
3223
3341
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3243,6 +3361,8 @@ exports.opRemovePublishListMember = opRemovePublishListMember;
|
|
|
3243
3361
|
* not the extensions OLTP database. The same operation works for
|
|
3244
3362
|
* roboledger tenant graphs (post-materialization) and the SEC shared
|
|
3245
3363
|
* repository (which uses the same XBRL hypercube schema).
|
|
3364
|
+
*
|
|
3365
|
+
* **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
3366
|
*/
|
|
3247
3367
|
const opBuildFactGrid = (options) => (options.client ?? client_gen_1.client).post({
|
|
3248
3368
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3256,6 +3376,10 @@ const opBuildFactGrid = (options) => (options.client ?? client_gen_1.client).pos
|
|
|
3256
3376
|
exports.opBuildFactGrid = opBuildFactGrid;
|
|
3257
3377
|
/**
|
|
3258
3378
|
* Create Portfolio
|
|
3379
|
+
*
|
|
3380
|
+
*
|
|
3381
|
+
*
|
|
3382
|
+
* **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
3383
|
*/
|
|
3260
3384
|
const opCreatePortfolio = (options) => (options.client ?? client_gen_1.client).post({
|
|
3261
3385
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3269,6 +3393,10 @@ const opCreatePortfolio = (options) => (options.client ?? client_gen_1.client).p
|
|
|
3269
3393
|
exports.opCreatePortfolio = opCreatePortfolio;
|
|
3270
3394
|
/**
|
|
3271
3395
|
* Update Portfolio
|
|
3396
|
+
*
|
|
3397
|
+
*
|
|
3398
|
+
*
|
|
3399
|
+
* **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
3400
|
*/
|
|
3273
3401
|
const opUpdatePortfolio = (options) => (options.client ?? client_gen_1.client).post({
|
|
3274
3402
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3282,6 +3410,10 @@ const opUpdatePortfolio = (options) => (options.client ?? client_gen_1.client).p
|
|
|
3282
3410
|
exports.opUpdatePortfolio = opUpdatePortfolio;
|
|
3283
3411
|
/**
|
|
3284
3412
|
* Delete Portfolio
|
|
3413
|
+
*
|
|
3414
|
+
*
|
|
3415
|
+
*
|
|
3416
|
+
* **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
3417
|
*/
|
|
3286
3418
|
const opDeletePortfolio = (options) => (options.client ?? client_gen_1.client).post({
|
|
3287
3419
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3295,6 +3427,10 @@ const opDeletePortfolio = (options) => (options.client ?? client_gen_1.client).p
|
|
|
3295
3427
|
exports.opDeletePortfolio = opDeletePortfolio;
|
|
3296
3428
|
/**
|
|
3297
3429
|
* Create Security
|
|
3430
|
+
*
|
|
3431
|
+
*
|
|
3432
|
+
*
|
|
3433
|
+
* **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
3434
|
*/
|
|
3299
3435
|
const opCreateSecurity = (options) => (options.client ?? client_gen_1.client).post({
|
|
3300
3436
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3308,6 +3444,10 @@ const opCreateSecurity = (options) => (options.client ?? client_gen_1.client).po
|
|
|
3308
3444
|
exports.opCreateSecurity = opCreateSecurity;
|
|
3309
3445
|
/**
|
|
3310
3446
|
* Update Security
|
|
3447
|
+
*
|
|
3448
|
+
*
|
|
3449
|
+
*
|
|
3450
|
+
* **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
3451
|
*/
|
|
3312
3452
|
const opUpdateSecurity = (options) => (options.client ?? client_gen_1.client).post({
|
|
3313
3453
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3321,6 +3461,10 @@ const opUpdateSecurity = (options) => (options.client ?? client_gen_1.client).po
|
|
|
3321
3461
|
exports.opUpdateSecurity = opUpdateSecurity;
|
|
3322
3462
|
/**
|
|
3323
3463
|
* Delete Security
|
|
3464
|
+
*
|
|
3465
|
+
*
|
|
3466
|
+
*
|
|
3467
|
+
* **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
3468
|
*/
|
|
3325
3469
|
const opDeleteSecurity = (options) => (options.client ?? client_gen_1.client).post({
|
|
3326
3470
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3334,6 +3478,10 @@ const opDeleteSecurity = (options) => (options.client ?? client_gen_1.client).po
|
|
|
3334
3478
|
exports.opDeleteSecurity = opDeleteSecurity;
|
|
3335
3479
|
/**
|
|
3336
3480
|
* Create Position
|
|
3481
|
+
*
|
|
3482
|
+
*
|
|
3483
|
+
*
|
|
3484
|
+
* **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
3485
|
*/
|
|
3338
3486
|
const opCreatePosition = (options) => (options.client ?? client_gen_1.client).post({
|
|
3339
3487
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3347,6 +3495,10 @@ const opCreatePosition = (options) => (options.client ?? client_gen_1.client).po
|
|
|
3347
3495
|
exports.opCreatePosition = opCreatePosition;
|
|
3348
3496
|
/**
|
|
3349
3497
|
* Update Position
|
|
3498
|
+
*
|
|
3499
|
+
*
|
|
3500
|
+
*
|
|
3501
|
+
* **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
3502
|
*/
|
|
3351
3503
|
const opUpdatePosition = (options) => (options.client ?? client_gen_1.client).post({
|
|
3352
3504
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -3360,6 +3512,10 @@ const opUpdatePosition = (options) => (options.client ?? client_gen_1.client).po
|
|
|
3360
3512
|
exports.opUpdatePosition = opUpdatePosition;
|
|
3361
3513
|
/**
|
|
3362
3514
|
* Delete Position
|
|
3515
|
+
*
|
|
3516
|
+
*
|
|
3517
|
+
*
|
|
3518
|
+
* **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
3519
|
*/
|
|
3364
3520
|
const opDeletePosition = (options) => (options.client ?? client_gen_1.client).post({
|
|
3365
3521
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|