@aderis-erp/cli 1.1.2 → 1.1.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/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-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 +158 -24
- 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 +11 -2
- package/dist/commands/credit-card-accounts.js +158 -24
- package/dist/commands/delivery-notes.d.ts +11 -2
- package/dist/commands/delivery-notes.js +158 -24
- 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/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/integration-identities.d.ts +11 -2
- package/dist/commands/integration-identities.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 +163 -24
- 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/ledgers.d.ts +11 -2
- package/dist/commands/ledgers.js +158 -24
- package/dist/commands/my-account.d.ts +11 -2
- package/dist/commands/my-account.js +157 -23
- 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 +158 -24
- 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/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 +162 -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 +161 -24
- package/dist/commands/webhooks.d.ts +11 -2
- package/dist/commands/webhooks.js +158 -24
- package/dist/commands/workflows.d.ts +11 -2
- package/dist/commands/workflows.js +157 -23
- package/dist/lib/api-client.d.ts +1 -0
- package/dist/lib/api-client.js +3 -0
- package/oclif.manifest.json +466 -162
- package/package.json +1 -1
|
@@ -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 = ["import"];
|
|
11
|
+
const NESTED_UPSERTS = ["notes", "files"];
|
|
12
|
+
const SUBCOMMANDS = [...["list", "create", "stats", "get", "update", "delete", "post", "approve", "cancel", "reverse", "update-lines", "get-deferrals", "create-deferrals", "list-notes", "create-notes", "get-notes", "update-notes", "delete-notes", "list-files", "create-files", "get-files", "update-files", "delete-files", "files-download", "import"], ...(HAS_UPSERT ? ['upsert'] : []), ...(HAS_EXPORT ? ['export'] : []), ...NESTED_UPSERTS.map(n => `upsert-${n}`)];
|
|
10
13
|
const ENDPOINTS = {
|
|
11
14
|
'list': { method: 'GET', path: '/v1/journals', summary: 'List all journals', pathParams: [], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
|
|
12
15
|
'create': { method: 'POST', path: '/v1/journals', summary: 'Create a new journal (with embedded lines)', pathParams: [], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: ['lines', 'files', 'notes'] },
|
|
@@ -32,6 +35,7 @@ const ENDPOINTS = {
|
|
|
32
35
|
'update-files': { method: 'PATCH', path: '/v1/journals/{parentId}/files/{fileId}', summary: 'Update file attachment metadata for a journal', pathParams: ['parentId', 'fileId'], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
|
|
33
36
|
'delete-files': { method: 'DELETE', path: '/v1/journals/{parentId}/files/{fileId}', summary: 'Delete a file attachment from a journal', pathParams: ['parentId', 'fileId'], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
|
|
34
37
|
'files-download': { method: 'GET', path: '/v1/journals/{parentId}/files/{fileId}/download', summary: 'Download a file attachment from a journal', pathParams: ['parentId', 'fileId'], hasBody: false, isMultipart: false, isBinaryResponse: true, hasBinaryVariant: false, bodyArrayFields: [] },
|
|
38
|
+
'import': { method: 'POST', path: '/v1/journals/import', summary: 'Import journals', pathParams: [], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
|
|
35
39
|
};
|
|
36
40
|
export default class Journals extends Command {
|
|
37
41
|
static description = 'Manage journals';
|
|
@@ -40,7 +44,7 @@ export default class Journals extends Command {
|
|
|
40
44
|
'<%= config.bin %> journals get <id>',
|
|
41
45
|
'<%= config.bin %> journals create --data \'{...}\'',
|
|
42
46
|
'<%= config.bin %> journals update <id> --set field=value',
|
|
43
|
-
'<%= config.bin %> journals import --file data.json',
|
|
47
|
+
'<%= config.bin %> journals import --file data.json --mode upsert',
|
|
44
48
|
'<%= config.bin %> journals export --csv > journals.csv',
|
|
45
49
|
];
|
|
46
50
|
static args = {
|
|
@@ -49,12 +53,16 @@ export default class Journals extends Command {
|
|
|
49
53
|
};
|
|
50
54
|
static flags = {
|
|
51
55
|
context: Flags.string({ char: 'c', aliases: ['config'], env: 'ADERIS_CONTEXT', description: 'Context to use for this command, overriding the current context (alias: --config)' }),
|
|
52
|
-
output: Flags.string({ char: 'o', description: 'Output format (default: table for
|
|
56
|
+
output: Flags.string({ char: 'o', description: 'Output format (default: table for upsert, json for other commands)', options: ['json', 'table', 'csv'] }),
|
|
53
57
|
table: Flags.boolean({ char: 't', description: 'Output as table (shortcut for --output table)' }),
|
|
54
58
|
csv: Flags.boolean({ description: 'Output as CSV (shortcut for --output csv)' }),
|
|
55
59
|
data: Flags.string({ char: 'd', description: 'JSON data for request body' }),
|
|
56
60
|
file: Flags.string({ char: 'f', description: 'Read request body from file' }),
|
|
57
61
|
set: Flags.string({ char: 's', description: 'Set individual field (e.g. --set firstName=John)', multiple: true }),
|
|
62
|
+
mode: Flags.string({ description: 'Import mode: upsert (default) creates, updates or skips each record; create refuses records that already exist; update refuses records that do not', options: ['upsert', 'create', 'update'] }),
|
|
63
|
+
reference: Flags.string({ description: 'Caller-defined text stored on the import run, for tracking and filtering' }),
|
|
64
|
+
async: Flags.boolean({ description: 'Import in the background: answers with a PENDING run to follow via "aderis imports get <id>"' }),
|
|
65
|
+
'idempotency-key': Flags.string({ description: 'Repeating a key returns the earlier import run unchanged and imports nothing' }),
|
|
58
66
|
'line-id': Flags.string({ description: 'Path param: lineId' }),
|
|
59
67
|
'note-id': Flags.string({ description: 'Path param: noteId' }),
|
|
60
68
|
'file-id': Flags.string({ description: 'Path param: fileId' }),
|
|
@@ -72,11 +80,26 @@ export default class Journals extends Command {
|
|
|
72
80
|
};
|
|
73
81
|
async run() {
|
|
74
82
|
const { args, flags } = await this.parse(Journals);
|
|
75
|
-
//
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
83
|
+
// Bulk actions. 'import' is the API's own endpoint: one request, answered
|
|
84
|
+
// by a run that records what happened to every record. 'upsert' is the CLI
|
|
85
|
+
// looping create/update. A resource has one or the other, never both.
|
|
86
|
+
if (args.action === 'upsert') {
|
|
87
|
+
if (!HAS_UPSERT) {
|
|
88
|
+
this.error(SERVER_IMPORTS.includes('import')
|
|
89
|
+
? 'This resource is imported by the API. Use: aderis journals import --file data.json'
|
|
90
|
+
: 'Upsert needs both a create and an update endpoint, which this resource does not have');
|
|
91
|
+
}
|
|
92
|
+
await this.runUpsert(flags);
|
|
93
|
+
return;
|
|
94
|
+
}
|
|
95
|
+
if (args.action.startsWith('upsert-')) {
|
|
96
|
+
const suffix = args.action.replace('upsert-', '');
|
|
97
|
+
if (!NESTED_UPSERTS.includes(suffix)) {
|
|
98
|
+
this.error(SERVER_IMPORTS.includes('import-' + suffix)
|
|
99
|
+
? `That resource is imported by the API. Use: aderis journals import-${suffix} <id> --file data.json`
|
|
100
|
+
: `Unknown action: ${args.action}. Available: ${SUBCOMMANDS.join(', ')}`);
|
|
101
|
+
}
|
|
102
|
+
await this.runNestedUpsert(suffix, args.id, flags);
|
|
80
103
|
return;
|
|
81
104
|
}
|
|
82
105
|
// Handle export action specially
|
|
@@ -93,12 +116,17 @@ export default class Journals extends Command {
|
|
|
93
116
|
await this.runCamt053Import(flags);
|
|
94
117
|
return;
|
|
95
118
|
}
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
119
|
+
if (SERVER_IMPORTS.includes(args.action)) {
|
|
120
|
+
await this.runServerImport(args.action, args.id, flags);
|
|
121
|
+
return;
|
|
122
|
+
}
|
|
123
|
+
// 'import' used to name the CLI's create/update loop on every resource. It
|
|
124
|
+
// now names the API endpoint, which most resources do not have.
|
|
125
|
+
if (args.action === 'import' || args.action.startsWith('import-')) {
|
|
126
|
+
const suffix = args.action === 'import' ? '' : '-' + args.action.replace('import-', '');
|
|
127
|
+
const loops = args.action === 'import' ? HAS_UPSERT : NESTED_UPSERTS.includes(args.action.replace('import-', ''));
|
|
128
|
+
if (loops) {
|
|
129
|
+
this.error(`This resource has no import endpoint. Use: aderis journals upsert${suffix}${suffix ? ' <id>' : ''} --file data.json`);
|
|
102
130
|
}
|
|
103
131
|
}
|
|
104
132
|
const endpoint = ENDPOINTS[args.action];
|
|
@@ -413,7 +441,7 @@ export default class Journals extends Command {
|
|
|
413
441
|
throw error;
|
|
414
442
|
}
|
|
415
443
|
}
|
|
416
|
-
async
|
|
444
|
+
async runUpsert(flags) {
|
|
417
445
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
418
446
|
if (!context)
|
|
419
447
|
this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
|
|
@@ -477,12 +505,12 @@ export default class Journals extends Command {
|
|
|
477
505
|
items = [item];
|
|
478
506
|
}
|
|
479
507
|
else {
|
|
480
|
-
this.error('
|
|
508
|
+
this.error('Upsert requires --file, --data, or --set flags');
|
|
481
509
|
}
|
|
482
510
|
const createEndpoint = ENDPOINTS['create'];
|
|
483
511
|
const updateEndpoint = ENDPOINTS['update'];
|
|
484
512
|
if (!createEndpoint || !updateEndpoint) {
|
|
485
|
-
this.error('
|
|
513
|
+
this.error('Upsert requires both create and update endpoints');
|
|
486
514
|
}
|
|
487
515
|
// Helper to extract identifier from item (id, code, or xxxCode)
|
|
488
516
|
const getItemIdentifier = (item) => {
|
|
@@ -625,6 +653,117 @@ export default class Journals extends Command {
|
|
|
625
653
|
this.log('');
|
|
626
654
|
this.log(`Summary: ${created} created, ${updated} updated, ${errors.length} failed`);
|
|
627
655
|
}
|
|
656
|
+
/**
|
|
657
|
+
* The API's own import: the whole array goes up in one request and comes
|
|
658
|
+
* back as an import run, which records what happened to every record. A bad
|
|
659
|
+
* record lands in errorLog and the rest are still applied, and the run stays
|
|
660
|
+
* readable afterwards with: aderis imports get <id>.
|
|
661
|
+
*/
|
|
662
|
+
async runServerImport(action, parentId, flags) {
|
|
663
|
+
const endpoint = ENDPOINTS[action];
|
|
664
|
+
if (!endpoint)
|
|
665
|
+
this.error(`Unknown action: ${action}. Available: ${SUBCOMMANDS.join(', ')}`);
|
|
666
|
+
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
667
|
+
if (!context)
|
|
668
|
+
this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
|
|
669
|
+
if (!hasCredentials(context))
|
|
670
|
+
this.error(missingCredentialsMessage(context));
|
|
671
|
+
let apiPath = endpoint.path;
|
|
672
|
+
if (endpoint.pathParams.length > 0) {
|
|
673
|
+
if (!parentId)
|
|
674
|
+
this.error(`Missing required argument: id. Usage: aderis journals ${action} <parent-id> --file data.json`);
|
|
675
|
+
apiPath = apiPath.replace(`{${endpoint.pathParams[0]}}`, parentId);
|
|
676
|
+
}
|
|
677
|
+
// The endpoint takes an array. A single object is wrapped, so importing
|
|
678
|
+
// one record reads the same as importing many.
|
|
679
|
+
let records = [];
|
|
680
|
+
if (flags.file) {
|
|
681
|
+
const fsModule = await import('node:fs');
|
|
682
|
+
try {
|
|
683
|
+
const content = JSON.parse(fsModule.readFileSync(flags.file, 'utf-8'));
|
|
684
|
+
records = Array.isArray(content) ? content : [content];
|
|
685
|
+
}
|
|
686
|
+
catch {
|
|
687
|
+
this.error(`Failed to read file: ${flags.file}`);
|
|
688
|
+
}
|
|
689
|
+
}
|
|
690
|
+
else if (flags.data) {
|
|
691
|
+
try {
|
|
692
|
+
const content = JSON.parse(flags.data);
|
|
693
|
+
records = Array.isArray(content) ? content : [content];
|
|
694
|
+
}
|
|
695
|
+
catch {
|
|
696
|
+
this.error('Invalid JSON in --data');
|
|
697
|
+
}
|
|
698
|
+
}
|
|
699
|
+
else {
|
|
700
|
+
this.error('Import requires --file or --data holding a JSON array of records');
|
|
701
|
+
}
|
|
702
|
+
if (records.length === 0)
|
|
703
|
+
this.error('Nothing to import: the input is an empty array');
|
|
704
|
+
const params = { format: 'json' };
|
|
705
|
+
if (flags.mode)
|
|
706
|
+
params.mode = flags.mode;
|
|
707
|
+
if (flags.reference)
|
|
708
|
+
params.reference = flags.reference;
|
|
709
|
+
if (flags.async)
|
|
710
|
+
params.async = true;
|
|
711
|
+
const headers = {};
|
|
712
|
+
if (flags['idempotency-key'])
|
|
713
|
+
headers['Idempotency-Key'] = flags['idempotency-key'];
|
|
714
|
+
if (flags['show-http-request']) {
|
|
715
|
+
const baseUrls = getBaseUrls(context.environment);
|
|
716
|
+
const queryString = '?' + Object.entries(params).map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(String(v))}`).join('&');
|
|
717
|
+
process.stderr.write(`\n${endpoint.method.toUpperCase()} ${baseUrls.api}${apiPath}${queryString}\n`);
|
|
718
|
+
process.stderr.write(`Body: [${records.length} record${records.length === 1 ? '' : 's'}]\n\n`);
|
|
719
|
+
}
|
|
720
|
+
try {
|
|
721
|
+
const response = await apiRequest(endpoint.method, apiPath, {
|
|
722
|
+
contextName: flags.context,
|
|
723
|
+
data: records,
|
|
724
|
+
headers,
|
|
725
|
+
params,
|
|
726
|
+
});
|
|
727
|
+
this.printImportRun(response.data, flags);
|
|
728
|
+
}
|
|
729
|
+
catch (error) {
|
|
730
|
+
if (error instanceof ApiError) {
|
|
731
|
+
this.error(`API Error (${error.status}): ${error.message}`);
|
|
732
|
+
}
|
|
733
|
+
throw error;
|
|
734
|
+
}
|
|
735
|
+
}
|
|
736
|
+
/** Renders an import run: its counts, then whatever the server refused. */
|
|
737
|
+
printImportRun(run, flags) {
|
|
738
|
+
if (flags.output === 'json') {
|
|
739
|
+
this.log(JSON.stringify(run, null, 2));
|
|
740
|
+
return;
|
|
741
|
+
}
|
|
742
|
+
const record = (run ?? {});
|
|
743
|
+
const count = (key) => (typeof record[key] === 'number' ? record[key] : 0);
|
|
744
|
+
const id = record.id ? String(record.id) : '';
|
|
745
|
+
this.log(`Import ${id} - ${String(record.status ?? 'UNKNOWN')}${record.async ? ' (background)' : ''}`);
|
|
746
|
+
this.log(` ${count('inputSize')} submitted, ${count('createdCount')} created, ${count('updatedCount')} updated, ${count('unchangedCount')} unchanged`);
|
|
747
|
+
if (count('errorCount') > 0)
|
|
748
|
+
this.log(` ${count('errorCount')} not applied: ${count('refusedCount')} refused, ${count('failedCount')} failed`);
|
|
749
|
+
if (count('warningCount') > 0)
|
|
750
|
+
this.log(` ${count('warningCount')} applied with a warning`);
|
|
751
|
+
// errorLog is keyed by the record's identifier, then by field name.
|
|
752
|
+
const errorLog = record.errorLog;
|
|
753
|
+
if (errorLog && Object.keys(errorLog).length > 0) {
|
|
754
|
+
this.log('');
|
|
755
|
+
for (const [key, fields] of Object.entries(errorLog)) {
|
|
756
|
+
for (const [field, messages] of Object.entries(fields ?? {})) {
|
|
757
|
+
for (const message of messages ?? [])
|
|
758
|
+
this.log(` ${key} ${field}: ${message}`);
|
|
759
|
+
}
|
|
760
|
+
}
|
|
761
|
+
}
|
|
762
|
+
if (record.async && id) {
|
|
763
|
+
this.log('');
|
|
764
|
+
this.log(`Follow it with: aderis imports get ${id}`);
|
|
765
|
+
}
|
|
766
|
+
}
|
|
628
767
|
async runExport(flags) {
|
|
629
768
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
630
769
|
if (!context)
|
|
@@ -803,9 +942,9 @@ export default class Journals extends Command {
|
|
|
803
942
|
throw error;
|
|
804
943
|
}
|
|
805
944
|
}
|
|
806
|
-
async
|
|
945
|
+
async runNestedUpsert(suffix, parentId, flags) {
|
|
807
946
|
if (!parentId) {
|
|
808
|
-
this.error(`Missing required argument: id. Usage: aderis journals
|
|
947
|
+
this.error(`Missing required argument: id. Usage: aderis journals upsert-${suffix} <parent-id> --file data.json`);
|
|
809
948
|
}
|
|
810
949
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
811
950
|
if (!context)
|
|
@@ -870,12 +1009,12 @@ export default class Journals extends Command {
|
|
|
870
1009
|
items = [item];
|
|
871
1010
|
}
|
|
872
1011
|
else {
|
|
873
|
-
this.error(
|
|
1012
|
+
this.error('Upsert requires --file, --data, or --set flags');
|
|
874
1013
|
}
|
|
875
1014
|
const createEndpoint = ENDPOINTS[`create-${suffix}`];
|
|
876
1015
|
const updateEndpoint = ENDPOINTS[`update-${suffix}`];
|
|
877
1016
|
if (!createEndpoint || !updateEndpoint) {
|
|
878
|
-
this.error(`
|
|
1017
|
+
this.error(`Upsert requires both create-${suffix} and update-${suffix} endpoints`);
|
|
879
1018
|
}
|
|
880
1019
|
// Build the base path with parent ID (first path param)
|
|
881
1020
|
const firstParam = createEndpoint.pathParams[0];
|
|
@@ -31,10 +31,19 @@ export default class Ledgers extends Command {
|
|
|
31
31
|
'show-http-request': import("@oclif/core/interfaces").BooleanFlag<boolean>;
|
|
32
32
|
};
|
|
33
33
|
run(): Promise<void>;
|
|
34
|
-
private
|
|
34
|
+
private runUpsert;
|
|
35
|
+
/**
|
|
36
|
+
* The API's own import: the whole array goes up in one request and comes
|
|
37
|
+
* back as an import run, which records what happened to every record. A bad
|
|
38
|
+
* record lands in errorLog and the rest are still applied, and the run stays
|
|
39
|
+
* readable afterwards with: aderis imports get <id>.
|
|
40
|
+
*/
|
|
41
|
+
private runServerImport;
|
|
42
|
+
/** Renders an import run: its counts, then whatever the server refused. */
|
|
43
|
+
private printImportRun;
|
|
35
44
|
private runExport;
|
|
36
45
|
private runCamt053Import;
|
|
37
|
-
private
|
|
46
|
+
private runNestedUpsert;
|
|
38
47
|
private parseFilterValue;
|
|
39
48
|
/** The page line under a table: which page, how many, and any sums the API returned. */
|
|
40
49
|
private printPageSummary;
|
package/dist/commands/ledgers.js
CHANGED
|
@@ -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 = ["month-end-closings", "month-end-closings-accruals", "month-end-closings-notes", "notes", "closings"];
|
|
12
|
+
const SUBCOMMANDS = [...["list", "create", "get", "update", "delete", "list-month-end-closings", "create-month-end-closings", "get-month-end-closings", "update-month-end-closings", "delete-month-end-closings", "month-end-closings-complete", "create-month-end-closings-provisional-booking", "delete-month-end-closings-provisional-booking", "month-end-closings-reopen", "list-month-end-closings-accruals", "create-month-end-closings-accruals", "update-month-end-closings-accruals", "delete-month-end-closings-accruals", "month-end-closings-accruals-accept", "month-end-closings-accruals-dismiss", "list-month-end-closings-accrual-accounts", "list-month-end-closings-findings", "update-month-end-closings-findings", "list-month-end-closings-notes", "create-month-end-closings-notes", "get-month-end-closings-notes", "update-month-end-closings-notes", "delete-month-end-closings-notes", "update-month-end-closings-agent-results", "month-end-closings-agent-run", "get-fx-rate", "replace-fx-rate-providers", "replace-closing-fx-rate-providers", "list-notes", "create-notes", "get-notes", "update-notes", "delete-notes", "list-closings", "create-closings", "get-closings", "update-closings", "closings-close", "closings-reopen", "list-posting-runs", "create-posting-runs", "posting-runs"], ...(HAS_UPSERT ? ['upsert'] : []), ...(HAS_EXPORT ? ['export'] : []), ...NESTED_UPSERTS.map(n => `upsert-${n}`)];
|
|
10
13
|
const ENDPOINTS = {
|
|
11
14
|
'list': { method: 'GET', path: '/v1/ledgers', summary: 'List all ledgers', pathParams: [], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
|
|
12
15
|
'create': { method: 'POST', path: '/v1/ledgers', summary: 'Create a new ledger', pathParams: [], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: ['notes', 'fxRateProviders', 'closingFxRateProviders'] },
|
|
@@ -63,7 +66,7 @@ export default class Ledgers extends Command {
|
|
|
63
66
|
'<%= config.bin %> ledgers get <id>',
|
|
64
67
|
'<%= config.bin %> ledgers create --data \'{...}\'',
|
|
65
68
|
'<%= config.bin %> ledgers update <id> --set field=value',
|
|
66
|
-
'<%= config.bin %> ledgers
|
|
69
|
+
'<%= config.bin %> ledgers upsert --file data.json',
|
|
67
70
|
'<%= config.bin %> ledgers export --csv > ledgers.csv',
|
|
68
71
|
];
|
|
69
72
|
static args = {
|
|
@@ -72,7 +75,7 @@ export default class Ledgers extends Command {
|
|
|
72
75
|
};
|
|
73
76
|
static flags = {
|
|
74
77
|
context: Flags.string({ char: 'c', aliases: ['config'], env: 'ADERIS_CONTEXT', description: 'Context to use for this command, overriding the current context (alias: --config)' }),
|
|
75
|
-
output: Flags.string({ char: 'o', description: 'Output format (default: table for
|
|
78
|
+
output: Flags.string({ char: 'o', description: 'Output format (default: table for upsert, json for other commands)', options: ['json', 'table', 'csv'] }),
|
|
76
79
|
table: Flags.boolean({ char: 't', description: 'Output as table (shortcut for --output table)' }),
|
|
77
80
|
csv: Flags.boolean({ description: 'Output as CSV (shortcut for --output csv)' }),
|
|
78
81
|
data: Flags.string({ char: 'd', description: 'JSON data for request body' }),
|
|
@@ -96,11 +99,26 @@ export default class Ledgers extends Command {
|
|
|
96
99
|
};
|
|
97
100
|
async run() {
|
|
98
101
|
const { args, flags } = await this.parse(Ledgers);
|
|
99
|
-
//
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
102
|
+
// Bulk actions. 'import' is the API's own endpoint: one request, answered
|
|
103
|
+
// by a run that records what happened to every record. 'upsert' is the CLI
|
|
104
|
+
// looping create/update. A resource has one or the other, never both.
|
|
105
|
+
if (args.action === 'upsert') {
|
|
106
|
+
if (!HAS_UPSERT) {
|
|
107
|
+
this.error(SERVER_IMPORTS.includes('import')
|
|
108
|
+
? 'This resource is imported by the API. Use: aderis ledgers import --file data.json'
|
|
109
|
+
: 'Upsert needs both a create and an update endpoint, which this resource does not have');
|
|
110
|
+
}
|
|
111
|
+
await this.runUpsert(flags);
|
|
112
|
+
return;
|
|
113
|
+
}
|
|
114
|
+
if (args.action.startsWith('upsert-')) {
|
|
115
|
+
const suffix = args.action.replace('upsert-', '');
|
|
116
|
+
if (!NESTED_UPSERTS.includes(suffix)) {
|
|
117
|
+
this.error(SERVER_IMPORTS.includes('import-' + suffix)
|
|
118
|
+
? `That resource is imported by the API. Use: aderis ledgers import-${suffix} <id> --file data.json`
|
|
119
|
+
: `Unknown action: ${args.action}. Available: ${SUBCOMMANDS.join(', ')}`);
|
|
120
|
+
}
|
|
121
|
+
await this.runNestedUpsert(suffix, args.id, flags);
|
|
104
122
|
return;
|
|
105
123
|
}
|
|
106
124
|
// Handle export action specially
|
|
@@ -117,12 +135,17 @@ export default class Ledgers extends Command {
|
|
|
117
135
|
await this.runCamt053Import(flags);
|
|
118
136
|
return;
|
|
119
137
|
}
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
138
|
+
if (SERVER_IMPORTS.includes(args.action)) {
|
|
139
|
+
await this.runServerImport(args.action, args.id, flags);
|
|
140
|
+
return;
|
|
141
|
+
}
|
|
142
|
+
// 'import' used to name the CLI's create/update loop on every resource. It
|
|
143
|
+
// now names the API endpoint, which most resources do not have.
|
|
144
|
+
if (args.action === 'import' || args.action.startsWith('import-')) {
|
|
145
|
+
const suffix = args.action === 'import' ? '' : '-' + args.action.replace('import-', '');
|
|
146
|
+
const loops = args.action === 'import' ? HAS_UPSERT : NESTED_UPSERTS.includes(args.action.replace('import-', ''));
|
|
147
|
+
if (loops) {
|
|
148
|
+
this.error(`This resource has no import endpoint. Use: aderis ledgers upsert${suffix}${suffix ? ' <id>' : ''} --file data.json`);
|
|
126
149
|
}
|
|
127
150
|
}
|
|
128
151
|
const endpoint = ENDPOINTS[args.action];
|
|
@@ -437,7 +460,7 @@ export default class Ledgers extends Command {
|
|
|
437
460
|
throw error;
|
|
438
461
|
}
|
|
439
462
|
}
|
|
440
|
-
async
|
|
463
|
+
async runUpsert(flags) {
|
|
441
464
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
442
465
|
if (!context)
|
|
443
466
|
this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
|
|
@@ -501,12 +524,12 @@ export default class Ledgers extends Command {
|
|
|
501
524
|
items = [item];
|
|
502
525
|
}
|
|
503
526
|
else {
|
|
504
|
-
this.error('
|
|
527
|
+
this.error('Upsert requires --file, --data, or --set flags');
|
|
505
528
|
}
|
|
506
529
|
const createEndpoint = ENDPOINTS['create'];
|
|
507
530
|
const updateEndpoint = ENDPOINTS['update'];
|
|
508
531
|
if (!createEndpoint || !updateEndpoint) {
|
|
509
|
-
this.error('
|
|
532
|
+
this.error('Upsert requires both create and update endpoints');
|
|
510
533
|
}
|
|
511
534
|
// Helper to extract identifier from item (id, code, or xxxCode)
|
|
512
535
|
const getItemIdentifier = (item) => {
|
|
@@ -649,6 +672,117 @@ export default class Ledgers extends Command {
|
|
|
649
672
|
this.log('');
|
|
650
673
|
this.log(`Summary: ${created} created, ${updated} updated, ${errors.length} failed`);
|
|
651
674
|
}
|
|
675
|
+
/**
|
|
676
|
+
* The API's own import: the whole array goes up in one request and comes
|
|
677
|
+
* back as an import run, which records what happened to every record. A bad
|
|
678
|
+
* record lands in errorLog and the rest are still applied, and the run stays
|
|
679
|
+
* readable afterwards with: aderis imports get <id>.
|
|
680
|
+
*/
|
|
681
|
+
async runServerImport(action, parentId, flags) {
|
|
682
|
+
const endpoint = ENDPOINTS[action];
|
|
683
|
+
if (!endpoint)
|
|
684
|
+
this.error(`Unknown action: ${action}. Available: ${SUBCOMMANDS.join(', ')}`);
|
|
685
|
+
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
686
|
+
if (!context)
|
|
687
|
+
this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
|
|
688
|
+
if (!hasCredentials(context))
|
|
689
|
+
this.error(missingCredentialsMessage(context));
|
|
690
|
+
let apiPath = endpoint.path;
|
|
691
|
+
if (endpoint.pathParams.length > 0) {
|
|
692
|
+
if (!parentId)
|
|
693
|
+
this.error(`Missing required argument: id. Usage: aderis ledgers ${action} <parent-id> --file data.json`);
|
|
694
|
+
apiPath = apiPath.replace(`{${endpoint.pathParams[0]}}`, parentId);
|
|
695
|
+
}
|
|
696
|
+
// The endpoint takes an array. A single object is wrapped, so importing
|
|
697
|
+
// one record reads the same as importing many.
|
|
698
|
+
let records = [];
|
|
699
|
+
if (flags.file) {
|
|
700
|
+
const fsModule = await import('node:fs');
|
|
701
|
+
try {
|
|
702
|
+
const content = JSON.parse(fsModule.readFileSync(flags.file, 'utf-8'));
|
|
703
|
+
records = Array.isArray(content) ? content : [content];
|
|
704
|
+
}
|
|
705
|
+
catch {
|
|
706
|
+
this.error(`Failed to read file: ${flags.file}`);
|
|
707
|
+
}
|
|
708
|
+
}
|
|
709
|
+
else if (flags.data) {
|
|
710
|
+
try {
|
|
711
|
+
const content = JSON.parse(flags.data);
|
|
712
|
+
records = Array.isArray(content) ? content : [content];
|
|
713
|
+
}
|
|
714
|
+
catch {
|
|
715
|
+
this.error('Invalid JSON in --data');
|
|
716
|
+
}
|
|
717
|
+
}
|
|
718
|
+
else {
|
|
719
|
+
this.error('Import requires --file or --data holding a JSON array of records');
|
|
720
|
+
}
|
|
721
|
+
if (records.length === 0)
|
|
722
|
+
this.error('Nothing to import: the input is an empty array');
|
|
723
|
+
const params = { format: 'json' };
|
|
724
|
+
if (flags.mode)
|
|
725
|
+
params.mode = flags.mode;
|
|
726
|
+
if (flags.reference)
|
|
727
|
+
params.reference = flags.reference;
|
|
728
|
+
if (flags.async)
|
|
729
|
+
params.async = true;
|
|
730
|
+
const headers = {};
|
|
731
|
+
if (flags['idempotency-key'])
|
|
732
|
+
headers['Idempotency-Key'] = flags['idempotency-key'];
|
|
733
|
+
if (flags['show-http-request']) {
|
|
734
|
+
const baseUrls = getBaseUrls(context.environment);
|
|
735
|
+
const queryString = '?' + Object.entries(params).map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(String(v))}`).join('&');
|
|
736
|
+
process.stderr.write(`\n${endpoint.method.toUpperCase()} ${baseUrls.api}${apiPath}${queryString}\n`);
|
|
737
|
+
process.stderr.write(`Body: [${records.length} record${records.length === 1 ? '' : 's'}]\n\n`);
|
|
738
|
+
}
|
|
739
|
+
try {
|
|
740
|
+
const response = await apiRequest(endpoint.method, apiPath, {
|
|
741
|
+
contextName: flags.context,
|
|
742
|
+
data: records,
|
|
743
|
+
headers,
|
|
744
|
+
params,
|
|
745
|
+
});
|
|
746
|
+
this.printImportRun(response.data, flags);
|
|
747
|
+
}
|
|
748
|
+
catch (error) {
|
|
749
|
+
if (error instanceof ApiError) {
|
|
750
|
+
this.error(`API Error (${error.status}): ${error.message}`);
|
|
751
|
+
}
|
|
752
|
+
throw error;
|
|
753
|
+
}
|
|
754
|
+
}
|
|
755
|
+
/** Renders an import run: its counts, then whatever the server refused. */
|
|
756
|
+
printImportRun(run, flags) {
|
|
757
|
+
if (flags.output === 'json') {
|
|
758
|
+
this.log(JSON.stringify(run, null, 2));
|
|
759
|
+
return;
|
|
760
|
+
}
|
|
761
|
+
const record = (run ?? {});
|
|
762
|
+
const count = (key) => (typeof record[key] === 'number' ? record[key] : 0);
|
|
763
|
+
const id = record.id ? String(record.id) : '';
|
|
764
|
+
this.log(`Import ${id} - ${String(record.status ?? 'UNKNOWN')}${record.async ? ' (background)' : ''}`);
|
|
765
|
+
this.log(` ${count('inputSize')} submitted, ${count('createdCount')} created, ${count('updatedCount')} updated, ${count('unchangedCount')} unchanged`);
|
|
766
|
+
if (count('errorCount') > 0)
|
|
767
|
+
this.log(` ${count('errorCount')} not applied: ${count('refusedCount')} refused, ${count('failedCount')} failed`);
|
|
768
|
+
if (count('warningCount') > 0)
|
|
769
|
+
this.log(` ${count('warningCount')} applied with a warning`);
|
|
770
|
+
// errorLog is keyed by the record's identifier, then by field name.
|
|
771
|
+
const errorLog = record.errorLog;
|
|
772
|
+
if (errorLog && Object.keys(errorLog).length > 0) {
|
|
773
|
+
this.log('');
|
|
774
|
+
for (const [key, fields] of Object.entries(errorLog)) {
|
|
775
|
+
for (const [field, messages] of Object.entries(fields ?? {})) {
|
|
776
|
+
for (const message of messages ?? [])
|
|
777
|
+
this.log(` ${key} ${field}: ${message}`);
|
|
778
|
+
}
|
|
779
|
+
}
|
|
780
|
+
}
|
|
781
|
+
if (record.async && id) {
|
|
782
|
+
this.log('');
|
|
783
|
+
this.log(`Follow it with: aderis imports get ${id}`);
|
|
784
|
+
}
|
|
785
|
+
}
|
|
652
786
|
async runExport(flags) {
|
|
653
787
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
654
788
|
if (!context)
|
|
@@ -827,9 +961,9 @@ export default class Ledgers extends Command {
|
|
|
827
961
|
throw error;
|
|
828
962
|
}
|
|
829
963
|
}
|
|
830
|
-
async
|
|
964
|
+
async runNestedUpsert(suffix, parentId, flags) {
|
|
831
965
|
if (!parentId) {
|
|
832
|
-
this.error(`Missing required argument: id. Usage: aderis ledgers
|
|
966
|
+
this.error(`Missing required argument: id. Usage: aderis ledgers upsert-${suffix} <parent-id> --file data.json`);
|
|
833
967
|
}
|
|
834
968
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
835
969
|
if (!context)
|
|
@@ -894,12 +1028,12 @@ export default class Ledgers extends Command {
|
|
|
894
1028
|
items = [item];
|
|
895
1029
|
}
|
|
896
1030
|
else {
|
|
897
|
-
this.error(
|
|
1031
|
+
this.error('Upsert requires --file, --data, or --set flags');
|
|
898
1032
|
}
|
|
899
1033
|
const createEndpoint = ENDPOINTS[`create-${suffix}`];
|
|
900
1034
|
const updateEndpoint = ENDPOINTS[`update-${suffix}`];
|
|
901
1035
|
if (!createEndpoint || !updateEndpoint) {
|
|
902
|
-
this.error(`
|
|
1036
|
+
this.error(`Upsert requires both create-${suffix} and update-${suffix} endpoints`);
|
|
903
1037
|
}
|
|
904
1038
|
// Build the base path with parent ID (first path param)
|
|
905
1039
|
const firstParam = createEndpoint.pathParams[0];
|
|
@@ -27,10 +27,19 @@ export default class MyAccount 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;
|