@aderis-erp/cli 1.1.2 → 1.1.4
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/README.md +1 -0
- package/dist/commands/access-groups.d.ts +11 -2
- package/dist/commands/access-groups.js +158 -24
- package/dist/commands/account-transaction-allocations.d.ts +11 -2
- package/dist/commands/account-transaction-allocations.js +157 -23
- package/dist/commands/account-transactions.d.ts +15 -2
- package/dist/commands/account-transactions.js +162 -24
- package/dist/commands/accounts.d.ts +11 -2
- package/dist/commands/accounts.js +158 -24
- package/dist/commands/agent-platform.d.ts +11 -3
- package/dist/commands/agent-platform.js +157 -32
- package/dist/commands/agent-runs.d.ts +11 -2
- package/dist/commands/agent-runs.js +157 -23
- package/dist/commands/analytics.d.ts +11 -2
- package/dist/commands/analytics.js +157 -23
- package/dist/commands/api-clients.d.ts +58 -0
- package/dist/commands/api-clients.js +1341 -0
- package/dist/commands/api-keys.d.ts +11 -2
- package/dist/commands/api-keys.js +157 -23
- package/dist/commands/async-jobs.d.ts +11 -2
- package/dist/commands/async-jobs.js +158 -24
- package/dist/commands/audit-log.d.ts +11 -2
- package/dist/commands/audit-log.js +157 -23
- package/dist/commands/bank-accounts.d.ts +11 -2
- package/dist/commands/bank-accounts.js +159 -25
- package/dist/commands/bank-integrations.d.ts +11 -2
- package/dist/commands/bank-integrations.js +158 -24
- package/dist/commands/business-partners.d.ts +11 -2
- package/dist/commands/business-partners.js +158 -24
- package/dist/commands/chat.d.ts +11 -2
- package/dist/commands/chat.js +158 -24
- package/dist/commands/credit-card-accounts.d.ts +15 -2
- package/dist/commands/credit-card-accounts.js +163 -24
- package/dist/commands/currencies.d.ts +56 -0
- package/dist/commands/currencies.js +1327 -0
- package/dist/commands/custody-accounts.d.ts +56 -0
- package/dist/commands/custody-accounts.js +1335 -0
- package/dist/commands/dashboards.d.ts +57 -0
- package/dist/commands/dashboards.js +1347 -0
- package/dist/commands/delivery-notes.d.ts +11 -2
- package/dist/commands/delivery-notes.js +158 -24
- package/dist/commands/{integration-identities.d.ts → document-checksums.d.ts} +12 -4
- package/dist/commands/{integration-identities.js → document-checksums.js} +162 -36
- package/dist/commands/dunning-configs.d.ts +11 -2
- package/dist/commands/dunning-configs.js +158 -24
- package/dist/commands/dunning-reminders.d.ts +11 -2
- package/dist/commands/dunning-reminders.js +157 -23
- package/dist/commands/dunning-runs.d.ts +11 -2
- package/dist/commands/dunning-runs.js +157 -23
- package/dist/commands/email-transactions.d.ts +11 -2
- package/dist/commands/email-transactions.js +157 -23
- package/dist/commands/employees.d.ts +13 -2
- package/dist/commands/employees.js +169 -24
- package/dist/commands/entity-configurations.d.ts +11 -2
- package/dist/commands/entity-configurations.js +157 -23
- package/dist/commands/event-mapping-rules.d.ts +56 -0
- package/dist/commands/event-mapping-rules.js +1324 -0
- package/dist/commands/event-processor-mappings.d.ts +11 -2
- package/dist/commands/event-processor-mappings.js +158 -24
- package/dist/commands/files.d.ts +11 -2
- package/dist/commands/files.js +158 -24
- package/dist/commands/financial-instrument-types.d.ts +56 -0
- package/dist/commands/financial-instrument-types.js +1335 -0
- package/dist/commands/financial-instruments.d.ts +56 -0
- package/dist/commands/financial-instruments.js +1335 -0
- package/dist/commands/health.d.ts +11 -2
- package/dist/commands/health.js +157 -23
- package/dist/commands/imports.d.ts +11 -2
- package/dist/commands/imports.js +157 -23
- package/dist/commands/inbox.d.ts +11 -2
- package/dist/commands/inbox.js +157 -23
- package/dist/commands/integrations.d.ts +11 -2
- package/dist/commands/integrations.js +157 -23
- package/dist/commands/item-categories.d.ts +11 -2
- package/dist/commands/item-categories.js +158 -24
- package/dist/commands/items.d.ts +15 -2
- package/dist/commands/items.js +165 -26
- package/dist/commands/journal-lines.d.ts +11 -2
- package/dist/commands/journal-lines.js +157 -23
- package/dist/commands/journals.d.ts +15 -2
- package/dist/commands/journals.js +163 -24
- package/dist/commands/{workflows.d.ts → kpis.d.ts} +12 -3
- package/dist/commands/kpis.js +1337 -0
- package/dist/commands/ledgers.d.ts +11 -2
- package/dist/commands/ledgers.js +159 -25
- package/dist/commands/my-account.d.ts +11 -2
- package/dist/commands/my-account.js +157 -23
- package/dist/commands/notifications.d.ts +56 -0
- package/dist/commands/notifications.js +1326 -0
- package/dist/commands/office-locations.d.ts +11 -2
- package/dist/commands/office-locations.js +158 -24
- package/dist/commands/payment-methods.d.ts +11 -2
- package/dist/commands/payment-methods.js +158 -24
- package/dist/commands/payment-runs.d.ts +11 -2
- package/dist/commands/payment-runs.js +158 -24
- package/dist/commands/payment-terms.d.ts +11 -2
- package/dist/commands/payment-terms.js +159 -25
- package/dist/commands/payments.d.ts +11 -2
- package/dist/commands/payments.js +158 -24
- package/dist/commands/payroll-runs.d.ts +11 -2
- package/dist/commands/payroll-runs.js +158 -24
- package/dist/commands/permissions.d.ts +11 -2
- package/dist/commands/permissions.js +157 -23
- package/dist/commands/price-lists.d.ts +15 -2
- package/dist/commands/price-lists.js +164 -24
- package/dist/commands/processor-mappings.d.ts +11 -2
- package/dist/commands/processor-mappings.js +158 -24
- package/dist/commands/processors.d.ts +11 -2
- package/dist/commands/processors.js +158 -24
- package/dist/commands/purchase-order-types.d.ts +11 -2
- package/dist/commands/purchase-order-types.js +158 -24
- package/dist/commands/purchase-orders.d.ts +11 -2
- package/dist/commands/purchase-orders.js +158 -24
- package/dist/commands/reports.d.ts +11 -2
- package/dist/commands/reports.js +157 -23
- package/dist/commands/roles.d.ts +11 -2
- package/dist/commands/roles.js +158 -24
- package/dist/commands/salary-types.d.ts +11 -2
- package/dist/commands/salary-types.js +158 -24
- package/dist/commands/sales-invoices.d.ts +11 -2
- package/dist/commands/sales-invoices.js +161 -24
- package/dist/commands/sales-orders.d.ts +11 -2
- package/dist/commands/sales-orders.js +159 -25
- package/dist/commands/saved-views.d.ts +11 -2
- package/dist/commands/saved-views.js +157 -23
- package/dist/commands/scheduled-processor-mappings.d.ts +11 -2
- package/dist/commands/scheduled-processor-mappings.js +158 -24
- package/dist/commands/schedules.d.ts +11 -2
- package/dist/commands/schedules.js +158 -24
- package/dist/commands/settings.d.ts +56 -0
- package/dist/commands/settings.js +1327 -0
- package/dist/commands/tags.d.ts +11 -2
- package/dist/commands/tags.js +158 -24
- package/dist/commands/tax-codes.d.ts +11 -2
- package/dist/commands/tax-codes.js +158 -24
- package/dist/commands/tax-matrix.d.ts +11 -2
- package/dist/commands/tax-matrix.js +158 -24
- package/dist/commands/templates.d.ts +11 -2
- package/dist/commands/templates.js +163 -24
- package/dist/commands/tenants.d.ts +11 -2
- package/dist/commands/tenants.js +158 -24
- package/dist/commands/tools.d.ts +11 -2
- package/dist/commands/tools.js +157 -23
- package/dist/commands/users.d.ts +11 -2
- package/dist/commands/users.js +158 -24
- package/dist/commands/vat-declarations.d.ts +11 -2
- package/dist/commands/vat-declarations.js +158 -24
- package/dist/commands/vendor-invoices.d.ts +11 -2
- package/dist/commands/vendor-invoices.js +162 -24
- package/dist/commands/webhooks.d.ts +11 -2
- package/dist/commands/webhooks.js +158 -24
- package/dist/commands/work-summary.d.ts +56 -0
- package/dist/commands/{workflows.js → work-summary.js} +164 -33
- package/dist/lib/api-client.d.ts +1 -0
- package/dist/lib/api-client.js +3 -0
- package/dist/lib/auth/index.js +5 -0
- package/dist/lib/production-guard.d.ts +42 -0
- package/dist/lib/production-guard.js +92 -0
- package/oclif.manifest.json +2358 -442
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -8,6 +8,7 @@ Command-line interface for Aderis Finance ERP. Manage your Aderis account, execu
|
|
|
8
8
|
- **Multi-Environment Support** - Switch between dev, test, staging and production environments
|
|
9
9
|
- **Multi-Client Support** - Manage multiple clients with named contexts
|
|
10
10
|
- **Multi-Tenant Support** - Switch between tenants within a single login
|
|
11
|
+
- **Production Guard for Claude Code** - From an `@aderis.com` address, only a Claude account in the Aderis organisation can reach `live`
|
|
11
12
|
- **Full API Access** - Execute all Aderis API endpoints from the command line
|
|
12
13
|
- **Auto-Generated Commands** - Commands generated directly from OpenAPI spec
|
|
13
14
|
|
|
@@ -27,10 +27,19 @@ export default class AccessGroups extends Command {
|
|
|
27
27
|
'show-http-request': import("@oclif/core/interfaces").BooleanFlag<boolean>;
|
|
28
28
|
};
|
|
29
29
|
run(): Promise<void>;
|
|
30
|
-
private
|
|
30
|
+
private runUpsert;
|
|
31
|
+
/**
|
|
32
|
+
* The API's own import: the whole array goes up in one request and comes
|
|
33
|
+
* back as an import run, which records what happened to every record. A bad
|
|
34
|
+
* record lands in errorLog and the rest are still applied, and the run stays
|
|
35
|
+
* readable afterwards with: aderis imports get <id>.
|
|
36
|
+
*/
|
|
37
|
+
private runServerImport;
|
|
38
|
+
/** Renders an import run: its counts, then whatever the server refused. */
|
|
39
|
+
private printImportRun;
|
|
31
40
|
private runExport;
|
|
32
41
|
private runCamt053Import;
|
|
33
|
-
private
|
|
42
|
+
private runNestedUpsert;
|
|
34
43
|
private parseFilterValue;
|
|
35
44
|
/** The page line under a table: which page, how many, and any sums the API returned. */
|
|
36
45
|
private printPageSummary;
|
|
@@ -1,12 +1,15 @@
|
|
|
1
1
|
import { Command, Args, Flags } from '@oclif/core';
|
|
2
2
|
import { apiRequest, ApiError, isTextualMediaType, normalizeSortBy } from '../lib/api-client.js';
|
|
3
3
|
import { getCurrentContext, getContext, getBaseUrls, hasCredentials, missingCredentialsMessage } from '../lib/config.js';
|
|
4
|
-
//
|
|
5
|
-
|
|
4
|
+
// 'upsert' loops create/update from the CLI, one request per record. It exists
|
|
5
|
+
// only where the API has no import endpoint of its own; those keep the name
|
|
6
|
+
// 'import' and are listed in SERVER_IMPORTS.
|
|
7
|
+
const HAS_UPSERT = true;
|
|
6
8
|
const HAS_EXPORT = true;
|
|
7
9
|
const HAS_CAMT053 = false;
|
|
8
|
-
const
|
|
9
|
-
const
|
|
10
|
+
const SERVER_IMPORTS = [];
|
|
11
|
+
const NESTED_UPSERTS = [];
|
|
12
|
+
const SUBCOMMANDS = [...["list", "create", "list-summaries", "get", "update", "delete"], ...(HAS_UPSERT ? ['upsert'] : []), ...(HAS_EXPORT ? ['export'] : []), ...NESTED_UPSERTS.map(n => `upsert-${n}`)];
|
|
10
13
|
const ENDPOINTS = {
|
|
11
14
|
'list': { method: 'GET', path: '/v1/access-groups', summary: 'List access groups (paginated)', pathParams: [], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
|
|
12
15
|
'create': { method: 'POST', path: '/v1/access-groups', summary: 'Create a new access group', pathParams: [], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: ['types', 'userIds'] },
|
|
@@ -22,7 +25,7 @@ export default class AccessGroups extends Command {
|
|
|
22
25
|
'<%= config.bin %> access-groups get <id>',
|
|
23
26
|
'<%= config.bin %> access-groups create --data \'{...}\'',
|
|
24
27
|
'<%= config.bin %> access-groups update <id> --set field=value',
|
|
25
|
-
'<%= config.bin %> access-groups
|
|
28
|
+
'<%= config.bin %> access-groups upsert --file data.json',
|
|
26
29
|
'<%= config.bin %> access-groups export --csv > access-groups.csv',
|
|
27
30
|
];
|
|
28
31
|
static args = {
|
|
@@ -31,7 +34,7 @@ export default class AccessGroups extends Command {
|
|
|
31
34
|
};
|
|
32
35
|
static flags = {
|
|
33
36
|
context: Flags.string({ char: 'c', aliases: ['config'], env: 'ADERIS_CONTEXT', description: 'Context to use for this command, overriding the current context (alias: --config)' }),
|
|
34
|
-
output: Flags.string({ char: 'o', description: 'Output format (default: table for
|
|
37
|
+
output: Flags.string({ char: 'o', description: 'Output format (default: table for upsert, json for other commands)', options: ['json', 'table', 'csv'] }),
|
|
35
38
|
table: Flags.boolean({ char: 't', description: 'Output as table (shortcut for --output table)' }),
|
|
36
39
|
csv: Flags.boolean({ description: 'Output as CSV (shortcut for --output csv)' }),
|
|
37
40
|
data: Flags.string({ char: 'd', description: 'JSON data for request body' }),
|
|
@@ -51,11 +54,26 @@ export default class AccessGroups extends Command {
|
|
|
51
54
|
};
|
|
52
55
|
async run() {
|
|
53
56
|
const { args, flags } = await this.parse(AccessGroups);
|
|
54
|
-
//
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
57
|
+
// Bulk actions. 'import' is the API's own endpoint: one request, answered
|
|
58
|
+
// by a run that records what happened to every record. 'upsert' is the CLI
|
|
59
|
+
// looping create/update. A resource has one or the other, never both.
|
|
60
|
+
if (args.action === 'upsert') {
|
|
61
|
+
if (!HAS_UPSERT) {
|
|
62
|
+
this.error(SERVER_IMPORTS.includes('import')
|
|
63
|
+
? 'This resource is imported by the API. Use: aderis access-groups import --file data.json'
|
|
64
|
+
: 'Upsert needs both a create and an update endpoint, which this resource does not have');
|
|
65
|
+
}
|
|
66
|
+
await this.runUpsert(flags);
|
|
67
|
+
return;
|
|
68
|
+
}
|
|
69
|
+
if (args.action.startsWith('upsert-')) {
|
|
70
|
+
const suffix = args.action.replace('upsert-', '');
|
|
71
|
+
if (!NESTED_UPSERTS.includes(suffix)) {
|
|
72
|
+
this.error(SERVER_IMPORTS.includes('import-' + suffix)
|
|
73
|
+
? `That resource is imported by the API. Use: aderis access-groups import-${suffix} <id> --file data.json`
|
|
74
|
+
: `Unknown action: ${args.action}. Available: ${SUBCOMMANDS.join(', ')}`);
|
|
75
|
+
}
|
|
76
|
+
await this.runNestedUpsert(suffix, args.id, flags);
|
|
59
77
|
return;
|
|
60
78
|
}
|
|
61
79
|
// Handle export action specially
|
|
@@ -72,12 +90,17 @@ export default class AccessGroups extends Command {
|
|
|
72
90
|
await this.runCamt053Import(flags);
|
|
73
91
|
return;
|
|
74
92
|
}
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
93
|
+
if (SERVER_IMPORTS.includes(args.action)) {
|
|
94
|
+
await this.runServerImport(args.action, args.id, flags);
|
|
95
|
+
return;
|
|
96
|
+
}
|
|
97
|
+
// 'import' used to name the CLI's create/update loop on every resource. It
|
|
98
|
+
// now names the API endpoint, which most resources do not have.
|
|
99
|
+
if (args.action === 'import' || args.action.startsWith('import-')) {
|
|
100
|
+
const suffix = args.action === 'import' ? '' : '-' + args.action.replace('import-', '');
|
|
101
|
+
const loops = args.action === 'import' ? HAS_UPSERT : NESTED_UPSERTS.includes(args.action.replace('import-', ''));
|
|
102
|
+
if (loops) {
|
|
103
|
+
this.error(`This resource has no import endpoint. Use: aderis access-groups upsert${suffix}${suffix ? ' <id>' : ''} --file data.json`);
|
|
81
104
|
}
|
|
82
105
|
}
|
|
83
106
|
const endpoint = ENDPOINTS[args.action];
|
|
@@ -392,7 +415,7 @@ export default class AccessGroups extends Command {
|
|
|
392
415
|
throw error;
|
|
393
416
|
}
|
|
394
417
|
}
|
|
395
|
-
async
|
|
418
|
+
async runUpsert(flags) {
|
|
396
419
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
397
420
|
if (!context)
|
|
398
421
|
this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
|
|
@@ -456,12 +479,12 @@ export default class AccessGroups extends Command {
|
|
|
456
479
|
items = [item];
|
|
457
480
|
}
|
|
458
481
|
else {
|
|
459
|
-
this.error('
|
|
482
|
+
this.error('Upsert requires --file, --data, or --set flags');
|
|
460
483
|
}
|
|
461
484
|
const createEndpoint = ENDPOINTS['create'];
|
|
462
485
|
const updateEndpoint = ENDPOINTS['update'];
|
|
463
486
|
if (!createEndpoint || !updateEndpoint) {
|
|
464
|
-
this.error('
|
|
487
|
+
this.error('Upsert requires both create and update endpoints');
|
|
465
488
|
}
|
|
466
489
|
// Helper to extract identifier from item (id, code, or xxxCode)
|
|
467
490
|
const getItemIdentifier = (item) => {
|
|
@@ -604,6 +627,117 @@ export default class AccessGroups extends Command {
|
|
|
604
627
|
this.log('');
|
|
605
628
|
this.log(`Summary: ${created} created, ${updated} updated, ${errors.length} failed`);
|
|
606
629
|
}
|
|
630
|
+
/**
|
|
631
|
+
* The API's own import: the whole array goes up in one request and comes
|
|
632
|
+
* back as an import run, which records what happened to every record. A bad
|
|
633
|
+
* record lands in errorLog and the rest are still applied, and the run stays
|
|
634
|
+
* readable afterwards with: aderis imports get <id>.
|
|
635
|
+
*/
|
|
636
|
+
async runServerImport(action, parentId, flags) {
|
|
637
|
+
const endpoint = ENDPOINTS[action];
|
|
638
|
+
if (!endpoint)
|
|
639
|
+
this.error(`Unknown action: ${action}. Available: ${SUBCOMMANDS.join(', ')}`);
|
|
640
|
+
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
641
|
+
if (!context)
|
|
642
|
+
this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
|
|
643
|
+
if (!hasCredentials(context))
|
|
644
|
+
this.error(missingCredentialsMessage(context));
|
|
645
|
+
let apiPath = endpoint.path;
|
|
646
|
+
if (endpoint.pathParams.length > 0) {
|
|
647
|
+
if (!parentId)
|
|
648
|
+
this.error(`Missing required argument: id. Usage: aderis access-groups ${action} <parent-id> --file data.json`);
|
|
649
|
+
apiPath = apiPath.replace(`{${endpoint.pathParams[0]}}`, parentId);
|
|
650
|
+
}
|
|
651
|
+
// The endpoint takes an array. A single object is wrapped, so importing
|
|
652
|
+
// one record reads the same as importing many.
|
|
653
|
+
let records = [];
|
|
654
|
+
if (flags.file) {
|
|
655
|
+
const fsModule = await import('node:fs');
|
|
656
|
+
try {
|
|
657
|
+
const content = JSON.parse(fsModule.readFileSync(flags.file, 'utf-8'));
|
|
658
|
+
records = Array.isArray(content) ? content : [content];
|
|
659
|
+
}
|
|
660
|
+
catch {
|
|
661
|
+
this.error(`Failed to read file: ${flags.file}`);
|
|
662
|
+
}
|
|
663
|
+
}
|
|
664
|
+
else if (flags.data) {
|
|
665
|
+
try {
|
|
666
|
+
const content = JSON.parse(flags.data);
|
|
667
|
+
records = Array.isArray(content) ? content : [content];
|
|
668
|
+
}
|
|
669
|
+
catch {
|
|
670
|
+
this.error('Invalid JSON in --data');
|
|
671
|
+
}
|
|
672
|
+
}
|
|
673
|
+
else {
|
|
674
|
+
this.error('Import requires --file or --data holding a JSON array of records');
|
|
675
|
+
}
|
|
676
|
+
if (records.length === 0)
|
|
677
|
+
this.error('Nothing to import: the input is an empty array');
|
|
678
|
+
const params = { format: 'json' };
|
|
679
|
+
if (flags.mode)
|
|
680
|
+
params.mode = flags.mode;
|
|
681
|
+
if (flags.reference)
|
|
682
|
+
params.reference = flags.reference;
|
|
683
|
+
if (flags.async)
|
|
684
|
+
params.async = true;
|
|
685
|
+
const headers = {};
|
|
686
|
+
if (flags['idempotency-key'])
|
|
687
|
+
headers['Idempotency-Key'] = flags['idempotency-key'];
|
|
688
|
+
if (flags['show-http-request']) {
|
|
689
|
+
const baseUrls = getBaseUrls(context.environment);
|
|
690
|
+
const queryString = '?' + Object.entries(params).map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(String(v))}`).join('&');
|
|
691
|
+
process.stderr.write(`\n${endpoint.method.toUpperCase()} ${baseUrls.api}${apiPath}${queryString}\n`);
|
|
692
|
+
process.stderr.write(`Body: [${records.length} record${records.length === 1 ? '' : 's'}]\n\n`);
|
|
693
|
+
}
|
|
694
|
+
try {
|
|
695
|
+
const response = await apiRequest(endpoint.method, apiPath, {
|
|
696
|
+
contextName: flags.context,
|
|
697
|
+
data: records,
|
|
698
|
+
headers,
|
|
699
|
+
params,
|
|
700
|
+
});
|
|
701
|
+
this.printImportRun(response.data, flags);
|
|
702
|
+
}
|
|
703
|
+
catch (error) {
|
|
704
|
+
if (error instanceof ApiError) {
|
|
705
|
+
this.error(`API Error (${error.status}): ${error.message}`);
|
|
706
|
+
}
|
|
707
|
+
throw error;
|
|
708
|
+
}
|
|
709
|
+
}
|
|
710
|
+
/** Renders an import run: its counts, then whatever the server refused. */
|
|
711
|
+
printImportRun(run, flags) {
|
|
712
|
+
if (flags.output === 'json') {
|
|
713
|
+
this.log(JSON.stringify(run, null, 2));
|
|
714
|
+
return;
|
|
715
|
+
}
|
|
716
|
+
const record = (run ?? {});
|
|
717
|
+
const count = (key) => (typeof record[key] === 'number' ? record[key] : 0);
|
|
718
|
+
const id = record.id ? String(record.id) : '';
|
|
719
|
+
this.log(`Import ${id} - ${String(record.status ?? 'UNKNOWN')}${record.async ? ' (background)' : ''}`);
|
|
720
|
+
this.log(` ${count('inputSize')} submitted, ${count('createdCount')} created, ${count('updatedCount')} updated, ${count('unchangedCount')} unchanged`);
|
|
721
|
+
if (count('errorCount') > 0)
|
|
722
|
+
this.log(` ${count('errorCount')} not applied: ${count('refusedCount')} refused, ${count('failedCount')} failed`);
|
|
723
|
+
if (count('warningCount') > 0)
|
|
724
|
+
this.log(` ${count('warningCount')} applied with a warning`);
|
|
725
|
+
// errorLog is keyed by the record's identifier, then by field name.
|
|
726
|
+
const errorLog = record.errorLog;
|
|
727
|
+
if (errorLog && Object.keys(errorLog).length > 0) {
|
|
728
|
+
this.log('');
|
|
729
|
+
for (const [key, fields] of Object.entries(errorLog)) {
|
|
730
|
+
for (const [field, messages] of Object.entries(fields ?? {})) {
|
|
731
|
+
for (const message of messages ?? [])
|
|
732
|
+
this.log(` ${key} ${field}: ${message}`);
|
|
733
|
+
}
|
|
734
|
+
}
|
|
735
|
+
}
|
|
736
|
+
if (record.async && id) {
|
|
737
|
+
this.log('');
|
|
738
|
+
this.log(`Follow it with: aderis imports get ${id}`);
|
|
739
|
+
}
|
|
740
|
+
}
|
|
607
741
|
async runExport(flags) {
|
|
608
742
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
609
743
|
if (!context)
|
|
@@ -782,9 +916,9 @@ export default class AccessGroups extends Command {
|
|
|
782
916
|
throw error;
|
|
783
917
|
}
|
|
784
918
|
}
|
|
785
|
-
async
|
|
919
|
+
async runNestedUpsert(suffix, parentId, flags) {
|
|
786
920
|
if (!parentId) {
|
|
787
|
-
this.error(`Missing required argument: id. Usage: aderis access-groups
|
|
921
|
+
this.error(`Missing required argument: id. Usage: aderis access-groups upsert-${suffix} <parent-id> --file data.json`);
|
|
788
922
|
}
|
|
789
923
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
790
924
|
if (!context)
|
|
@@ -849,12 +983,12 @@ export default class AccessGroups extends Command {
|
|
|
849
983
|
items = [item];
|
|
850
984
|
}
|
|
851
985
|
else {
|
|
852
|
-
this.error(
|
|
986
|
+
this.error('Upsert requires --file, --data, or --set flags');
|
|
853
987
|
}
|
|
854
988
|
const createEndpoint = ENDPOINTS[`create-${suffix}`];
|
|
855
989
|
const updateEndpoint = ENDPOINTS[`update-${suffix}`];
|
|
856
990
|
if (!createEndpoint || !updateEndpoint) {
|
|
857
|
-
this.error(`
|
|
991
|
+
this.error(`Upsert requires both create-${suffix} and update-${suffix} endpoints`);
|
|
858
992
|
}
|
|
859
993
|
// Build the base path with parent ID (first path param)
|
|
860
994
|
const firstParam = createEndpoint.pathParams[0];
|
|
@@ -27,10 +27,19 @@ export default class AccountTransactionAllocations extends Command {
|
|
|
27
27
|
'show-http-request': import("@oclif/core/interfaces").BooleanFlag<boolean>;
|
|
28
28
|
};
|
|
29
29
|
run(): Promise<void>;
|
|
30
|
-
private
|
|
30
|
+
private runUpsert;
|
|
31
|
+
/**
|
|
32
|
+
* The API's own import: the whole array goes up in one request and comes
|
|
33
|
+
* back as an import run, which records what happened to every record. A bad
|
|
34
|
+
* record lands in errorLog and the rest are still applied, and the run stays
|
|
35
|
+
* readable afterwards with: aderis imports get <id>.
|
|
36
|
+
*/
|
|
37
|
+
private runServerImport;
|
|
38
|
+
/** Renders an import run: its counts, then whatever the server refused. */
|
|
39
|
+
private printImportRun;
|
|
31
40
|
private runExport;
|
|
32
41
|
private runCamt053Import;
|
|
33
|
-
private
|
|
42
|
+
private runNestedUpsert;
|
|
34
43
|
private parseFilterValue;
|
|
35
44
|
/** The page line under a table: which page, how many, and any sums the API returned. */
|
|
36
45
|
private printPageSummary;
|
|
@@ -1,12 +1,15 @@
|
|
|
1
1
|
import { Command, Args, Flags } from '@oclif/core';
|
|
2
2
|
import { apiRequest, ApiError, isTextualMediaType, normalizeSortBy } from '../lib/api-client.js';
|
|
3
3
|
import { getCurrentContext, getContext, getBaseUrls, hasCredentials, missingCredentialsMessage } from '../lib/config.js';
|
|
4
|
-
//
|
|
5
|
-
|
|
4
|
+
// 'upsert' loops create/update from the CLI, one request per record. It exists
|
|
5
|
+
// only where the API has no import endpoint of its own; those keep the name
|
|
6
|
+
// 'import' and are listed in SERVER_IMPORTS.
|
|
7
|
+
const HAS_UPSERT = false;
|
|
6
8
|
const HAS_EXPORT = true;
|
|
7
9
|
const HAS_CAMT053 = false;
|
|
8
|
-
const
|
|
9
|
-
const
|
|
10
|
+
const SERVER_IMPORTS = [];
|
|
11
|
+
const NESTED_UPSERTS = [];
|
|
12
|
+
const SUBCOMMANDS = [...["list", "get"], ...(HAS_UPSERT ? ['upsert'] : []), ...(HAS_EXPORT ? ['export'] : []), ...NESTED_UPSERTS.map(n => `upsert-${n}`)];
|
|
10
13
|
const ENDPOINTS = {
|
|
11
14
|
'list': { method: 'GET', path: '/v1/account-transaction-allocations', summary: 'List account transaction allocations with pagination', pathParams: [], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
|
|
12
15
|
'get': { method: 'GET', path: '/v1/account-transaction-allocations/{id}', summary: 'Get an account transaction allocation by ID', pathParams: ['id'], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
|
|
@@ -24,7 +27,7 @@ export default class AccountTransactionAllocations extends Command {
|
|
|
24
27
|
};
|
|
25
28
|
static flags = {
|
|
26
29
|
context: Flags.string({ char: 'c', aliases: ['config'], env: 'ADERIS_CONTEXT', description: 'Context to use for this command, overriding the current context (alias: --config)' }),
|
|
27
|
-
output: Flags.string({ char: 'o', description: 'Output format (default: table for
|
|
30
|
+
output: Flags.string({ char: 'o', description: 'Output format (default: table for upsert, json for other commands)', options: ['json', 'table', 'csv'] }),
|
|
28
31
|
table: Flags.boolean({ char: 't', description: 'Output as table (shortcut for --output table)' }),
|
|
29
32
|
csv: Flags.boolean({ description: 'Output as CSV (shortcut for --output csv)' }),
|
|
30
33
|
data: Flags.string({ char: 'd', description: 'JSON data for request body' }),
|
|
@@ -44,11 +47,26 @@ export default class AccountTransactionAllocations extends Command {
|
|
|
44
47
|
};
|
|
45
48
|
async run() {
|
|
46
49
|
const { args, flags } = await this.parse(AccountTransactionAllocations);
|
|
47
|
-
//
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
50
|
+
// Bulk actions. 'import' is the API's own endpoint: one request, answered
|
|
51
|
+
// by a run that records what happened to every record. 'upsert' is the CLI
|
|
52
|
+
// looping create/update. A resource has one or the other, never both.
|
|
53
|
+
if (args.action === 'upsert') {
|
|
54
|
+
if (!HAS_UPSERT) {
|
|
55
|
+
this.error(SERVER_IMPORTS.includes('import')
|
|
56
|
+
? 'This resource is imported by the API. Use: aderis account-transaction-allocations import --file data.json'
|
|
57
|
+
: 'Upsert needs both a create and an update endpoint, which this resource does not have');
|
|
58
|
+
}
|
|
59
|
+
await this.runUpsert(flags);
|
|
60
|
+
return;
|
|
61
|
+
}
|
|
62
|
+
if (args.action.startsWith('upsert-')) {
|
|
63
|
+
const suffix = args.action.replace('upsert-', '');
|
|
64
|
+
if (!NESTED_UPSERTS.includes(suffix)) {
|
|
65
|
+
this.error(SERVER_IMPORTS.includes('import-' + suffix)
|
|
66
|
+
? `That resource is imported by the API. Use: aderis account-transaction-allocations import-${suffix} <id> --file data.json`
|
|
67
|
+
: `Unknown action: ${args.action}. Available: ${SUBCOMMANDS.join(', ')}`);
|
|
68
|
+
}
|
|
69
|
+
await this.runNestedUpsert(suffix, args.id, flags);
|
|
52
70
|
return;
|
|
53
71
|
}
|
|
54
72
|
// Handle export action specially
|
|
@@ -65,12 +83,17 @@ export default class AccountTransactionAllocations extends Command {
|
|
|
65
83
|
await this.runCamt053Import(flags);
|
|
66
84
|
return;
|
|
67
85
|
}
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
86
|
+
if (SERVER_IMPORTS.includes(args.action)) {
|
|
87
|
+
await this.runServerImport(args.action, args.id, flags);
|
|
88
|
+
return;
|
|
89
|
+
}
|
|
90
|
+
// 'import' used to name the CLI's create/update loop on every resource. It
|
|
91
|
+
// now names the API endpoint, which most resources do not have.
|
|
92
|
+
if (args.action === 'import' || args.action.startsWith('import-')) {
|
|
93
|
+
const suffix = args.action === 'import' ? '' : '-' + args.action.replace('import-', '');
|
|
94
|
+
const loops = args.action === 'import' ? HAS_UPSERT : NESTED_UPSERTS.includes(args.action.replace('import-', ''));
|
|
95
|
+
if (loops) {
|
|
96
|
+
this.error(`This resource has no import endpoint. Use: aderis account-transaction-allocations upsert${suffix}${suffix ? ' <id>' : ''} --file data.json`);
|
|
74
97
|
}
|
|
75
98
|
}
|
|
76
99
|
const endpoint = ENDPOINTS[args.action];
|
|
@@ -385,7 +408,7 @@ export default class AccountTransactionAllocations extends Command {
|
|
|
385
408
|
throw error;
|
|
386
409
|
}
|
|
387
410
|
}
|
|
388
|
-
async
|
|
411
|
+
async runUpsert(flags) {
|
|
389
412
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
390
413
|
if (!context)
|
|
391
414
|
this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
|
|
@@ -449,12 +472,12 @@ export default class AccountTransactionAllocations extends Command {
|
|
|
449
472
|
items = [item];
|
|
450
473
|
}
|
|
451
474
|
else {
|
|
452
|
-
this.error('
|
|
475
|
+
this.error('Upsert requires --file, --data, or --set flags');
|
|
453
476
|
}
|
|
454
477
|
const createEndpoint = ENDPOINTS['create'];
|
|
455
478
|
const updateEndpoint = ENDPOINTS['update'];
|
|
456
479
|
if (!createEndpoint || !updateEndpoint) {
|
|
457
|
-
this.error('
|
|
480
|
+
this.error('Upsert requires both create and update endpoints');
|
|
458
481
|
}
|
|
459
482
|
// Helper to extract identifier from item (id, code, or xxxCode)
|
|
460
483
|
const getItemIdentifier = (item) => {
|
|
@@ -597,6 +620,117 @@ export default class AccountTransactionAllocations extends Command {
|
|
|
597
620
|
this.log('');
|
|
598
621
|
this.log(`Summary: ${created} created, ${updated} updated, ${errors.length} failed`);
|
|
599
622
|
}
|
|
623
|
+
/**
|
|
624
|
+
* The API's own import: the whole array goes up in one request and comes
|
|
625
|
+
* back as an import run, which records what happened to every record. A bad
|
|
626
|
+
* record lands in errorLog and the rest are still applied, and the run stays
|
|
627
|
+
* readable afterwards with: aderis imports get <id>.
|
|
628
|
+
*/
|
|
629
|
+
async runServerImport(action, parentId, flags) {
|
|
630
|
+
const endpoint = ENDPOINTS[action];
|
|
631
|
+
if (!endpoint)
|
|
632
|
+
this.error(`Unknown action: ${action}. Available: ${SUBCOMMANDS.join(', ')}`);
|
|
633
|
+
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
634
|
+
if (!context)
|
|
635
|
+
this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
|
|
636
|
+
if (!hasCredentials(context))
|
|
637
|
+
this.error(missingCredentialsMessage(context));
|
|
638
|
+
let apiPath = endpoint.path;
|
|
639
|
+
if (endpoint.pathParams.length > 0) {
|
|
640
|
+
if (!parentId)
|
|
641
|
+
this.error(`Missing required argument: id. Usage: aderis account-transaction-allocations ${action} <parent-id> --file data.json`);
|
|
642
|
+
apiPath = apiPath.replace(`{${endpoint.pathParams[0]}}`, parentId);
|
|
643
|
+
}
|
|
644
|
+
// The endpoint takes an array. A single object is wrapped, so importing
|
|
645
|
+
// one record reads the same as importing many.
|
|
646
|
+
let records = [];
|
|
647
|
+
if (flags.file) {
|
|
648
|
+
const fsModule = await import('node:fs');
|
|
649
|
+
try {
|
|
650
|
+
const content = JSON.parse(fsModule.readFileSync(flags.file, 'utf-8'));
|
|
651
|
+
records = Array.isArray(content) ? content : [content];
|
|
652
|
+
}
|
|
653
|
+
catch {
|
|
654
|
+
this.error(`Failed to read file: ${flags.file}`);
|
|
655
|
+
}
|
|
656
|
+
}
|
|
657
|
+
else if (flags.data) {
|
|
658
|
+
try {
|
|
659
|
+
const content = JSON.parse(flags.data);
|
|
660
|
+
records = Array.isArray(content) ? content : [content];
|
|
661
|
+
}
|
|
662
|
+
catch {
|
|
663
|
+
this.error('Invalid JSON in --data');
|
|
664
|
+
}
|
|
665
|
+
}
|
|
666
|
+
else {
|
|
667
|
+
this.error('Import requires --file or --data holding a JSON array of records');
|
|
668
|
+
}
|
|
669
|
+
if (records.length === 0)
|
|
670
|
+
this.error('Nothing to import: the input is an empty array');
|
|
671
|
+
const params = { format: 'json' };
|
|
672
|
+
if (flags.mode)
|
|
673
|
+
params.mode = flags.mode;
|
|
674
|
+
if (flags.reference)
|
|
675
|
+
params.reference = flags.reference;
|
|
676
|
+
if (flags.async)
|
|
677
|
+
params.async = true;
|
|
678
|
+
const headers = {};
|
|
679
|
+
if (flags['idempotency-key'])
|
|
680
|
+
headers['Idempotency-Key'] = flags['idempotency-key'];
|
|
681
|
+
if (flags['show-http-request']) {
|
|
682
|
+
const baseUrls = getBaseUrls(context.environment);
|
|
683
|
+
const queryString = '?' + Object.entries(params).map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(String(v))}`).join('&');
|
|
684
|
+
process.stderr.write(`\n${endpoint.method.toUpperCase()} ${baseUrls.api}${apiPath}${queryString}\n`);
|
|
685
|
+
process.stderr.write(`Body: [${records.length} record${records.length === 1 ? '' : 's'}]\n\n`);
|
|
686
|
+
}
|
|
687
|
+
try {
|
|
688
|
+
const response = await apiRequest(endpoint.method, apiPath, {
|
|
689
|
+
contextName: flags.context,
|
|
690
|
+
data: records,
|
|
691
|
+
headers,
|
|
692
|
+
params,
|
|
693
|
+
});
|
|
694
|
+
this.printImportRun(response.data, flags);
|
|
695
|
+
}
|
|
696
|
+
catch (error) {
|
|
697
|
+
if (error instanceof ApiError) {
|
|
698
|
+
this.error(`API Error (${error.status}): ${error.message}`);
|
|
699
|
+
}
|
|
700
|
+
throw error;
|
|
701
|
+
}
|
|
702
|
+
}
|
|
703
|
+
/** Renders an import run: its counts, then whatever the server refused. */
|
|
704
|
+
printImportRun(run, flags) {
|
|
705
|
+
if (flags.output === 'json') {
|
|
706
|
+
this.log(JSON.stringify(run, null, 2));
|
|
707
|
+
return;
|
|
708
|
+
}
|
|
709
|
+
const record = (run ?? {});
|
|
710
|
+
const count = (key) => (typeof record[key] === 'number' ? record[key] : 0);
|
|
711
|
+
const id = record.id ? String(record.id) : '';
|
|
712
|
+
this.log(`Import ${id} - ${String(record.status ?? 'UNKNOWN')}${record.async ? ' (background)' : ''}`);
|
|
713
|
+
this.log(` ${count('inputSize')} submitted, ${count('createdCount')} created, ${count('updatedCount')} updated, ${count('unchangedCount')} unchanged`);
|
|
714
|
+
if (count('errorCount') > 0)
|
|
715
|
+
this.log(` ${count('errorCount')} not applied: ${count('refusedCount')} refused, ${count('failedCount')} failed`);
|
|
716
|
+
if (count('warningCount') > 0)
|
|
717
|
+
this.log(` ${count('warningCount')} applied with a warning`);
|
|
718
|
+
// errorLog is keyed by the record's identifier, then by field name.
|
|
719
|
+
const errorLog = record.errorLog;
|
|
720
|
+
if (errorLog && Object.keys(errorLog).length > 0) {
|
|
721
|
+
this.log('');
|
|
722
|
+
for (const [key, fields] of Object.entries(errorLog)) {
|
|
723
|
+
for (const [field, messages] of Object.entries(fields ?? {})) {
|
|
724
|
+
for (const message of messages ?? [])
|
|
725
|
+
this.log(` ${key} ${field}: ${message}`);
|
|
726
|
+
}
|
|
727
|
+
}
|
|
728
|
+
}
|
|
729
|
+
if (record.async && id) {
|
|
730
|
+
this.log('');
|
|
731
|
+
this.log(`Follow it with: aderis imports get ${id}`);
|
|
732
|
+
}
|
|
733
|
+
}
|
|
600
734
|
async runExport(flags) {
|
|
601
735
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
602
736
|
if (!context)
|
|
@@ -775,9 +909,9 @@ export default class AccountTransactionAllocations extends Command {
|
|
|
775
909
|
throw error;
|
|
776
910
|
}
|
|
777
911
|
}
|
|
778
|
-
async
|
|
912
|
+
async runNestedUpsert(suffix, parentId, flags) {
|
|
779
913
|
if (!parentId) {
|
|
780
|
-
this.error(`Missing required argument: id. Usage: aderis account-transaction-allocations
|
|
914
|
+
this.error(`Missing required argument: id. Usage: aderis account-transaction-allocations upsert-${suffix} <parent-id> --file data.json`);
|
|
781
915
|
}
|
|
782
916
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
783
917
|
if (!context)
|
|
@@ -842,12 +976,12 @@ export default class AccountTransactionAllocations extends Command {
|
|
|
842
976
|
items = [item];
|
|
843
977
|
}
|
|
844
978
|
else {
|
|
845
|
-
this.error(
|
|
979
|
+
this.error('Upsert requires --file, --data, or --set flags');
|
|
846
980
|
}
|
|
847
981
|
const createEndpoint = ENDPOINTS[`create-${suffix}`];
|
|
848
982
|
const updateEndpoint = ENDPOINTS[`update-${suffix}`];
|
|
849
983
|
if (!createEndpoint || !updateEndpoint) {
|
|
850
|
-
this.error(`
|
|
984
|
+
this.error(`Upsert requires both create-${suffix} and update-${suffix} endpoints`);
|
|
851
985
|
}
|
|
852
986
|
// Build the base path with parent ID (first path param)
|
|
853
987
|
const firstParam = createEndpoint.pathParams[0];
|
|
@@ -14,6 +14,10 @@ export default class AccountTransactions extends Command {
|
|
|
14
14
|
data: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
15
15
|
file: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
16
16
|
set: import("@oclif/core/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
17
|
+
mode: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
18
|
+
reference: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
19
|
+
async: import("@oclif/core/interfaces").BooleanFlag<boolean>;
|
|
20
|
+
'idempotency-key': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
17
21
|
'allocation-id': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
18
22
|
'note-id': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
19
23
|
page: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
@@ -29,10 +33,19 @@ export default class AccountTransactions extends Command {
|
|
|
29
33
|
'show-http-request': import("@oclif/core/interfaces").BooleanFlag<boolean>;
|
|
30
34
|
};
|
|
31
35
|
run(): Promise<void>;
|
|
32
|
-
private
|
|
36
|
+
private runUpsert;
|
|
37
|
+
/**
|
|
38
|
+
* The API's own import: the whole array goes up in one request and comes
|
|
39
|
+
* back as an import run, which records what happened to every record. A bad
|
|
40
|
+
* record lands in errorLog and the rest are still applied, and the run stays
|
|
41
|
+
* readable afterwards with: aderis imports get <id>.
|
|
42
|
+
*/
|
|
43
|
+
private runServerImport;
|
|
44
|
+
/** Renders an import run: its counts, then whatever the server refused. */
|
|
45
|
+
private printImportRun;
|
|
33
46
|
private runExport;
|
|
34
47
|
private runCamt053Import;
|
|
35
|
-
private
|
|
48
|
+
private runNestedUpsert;
|
|
36
49
|
private parseFilterValue;
|
|
37
50
|
/** The page line under a table: which page, how many, and any sums the API returned. */
|
|
38
51
|
private printPageSummary;
|