@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
|
@@ -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 = false;
|
|
7
9
|
const HAS_CAMT053 = false;
|
|
8
|
-
const
|
|
9
|
-
const
|
|
10
|
+
const SERVER_IMPORTS = [];
|
|
11
|
+
const NESTED_UPSERTS = [];
|
|
12
|
+
const SUBCOMMANDS = [...["trigger"], ...(HAS_UPSERT ? ['upsert'] : []), ...(HAS_EXPORT ? ['export'] : []), ...NESTED_UPSERTS.map(n => `upsert-${n}`)];
|
|
10
13
|
const ENDPOINTS = {
|
|
11
14
|
'trigger': { method: 'POST', path: '/v1/dunning-runs/trigger', summary: 'Manually trigger a dunning run', pathParams: [], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
|
|
12
15
|
};
|
|
@@ -19,7 +22,7 @@ export default class DunningRuns extends Command {
|
|
|
19
22
|
};
|
|
20
23
|
static flags = {
|
|
21
24
|
context: Flags.string({ char: 'c', aliases: ['config'], env: 'ADERIS_CONTEXT', description: 'Context to use for this command, overriding the current context (alias: --config)' }),
|
|
22
|
-
output: Flags.string({ char: 'o', description: 'Output format (default: table for
|
|
25
|
+
output: Flags.string({ char: 'o', description: 'Output format (default: table for upsert, json for other commands)', options: ['json', 'table', 'csv'] }),
|
|
23
26
|
table: Flags.boolean({ char: 't', description: 'Output as table (shortcut for --output table)' }),
|
|
24
27
|
csv: Flags.boolean({ description: 'Output as CSV (shortcut for --output csv)' }),
|
|
25
28
|
data: Flags.string({ char: 'd', description: 'JSON data for request body' }),
|
|
@@ -39,11 +42,26 @@ export default class DunningRuns extends Command {
|
|
|
39
42
|
};
|
|
40
43
|
async run() {
|
|
41
44
|
const { args, flags } = await this.parse(DunningRuns);
|
|
42
|
-
//
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
45
|
+
// Bulk actions. 'import' is the API's own endpoint: one request, answered
|
|
46
|
+
// by a run that records what happened to every record. 'upsert' is the CLI
|
|
47
|
+
// looping create/update. A resource has one or the other, never both.
|
|
48
|
+
if (args.action === 'upsert') {
|
|
49
|
+
if (!HAS_UPSERT) {
|
|
50
|
+
this.error(SERVER_IMPORTS.includes('import')
|
|
51
|
+
? 'This resource is imported by the API. Use: aderis dunning-runs import --file data.json'
|
|
52
|
+
: 'Upsert needs both a create and an update endpoint, which this resource does not have');
|
|
53
|
+
}
|
|
54
|
+
await this.runUpsert(flags);
|
|
55
|
+
return;
|
|
56
|
+
}
|
|
57
|
+
if (args.action.startsWith('upsert-')) {
|
|
58
|
+
const suffix = args.action.replace('upsert-', '');
|
|
59
|
+
if (!NESTED_UPSERTS.includes(suffix)) {
|
|
60
|
+
this.error(SERVER_IMPORTS.includes('import-' + suffix)
|
|
61
|
+
? `That resource is imported by the API. Use: aderis dunning-runs import-${suffix} <id> --file data.json`
|
|
62
|
+
: `Unknown action: ${args.action}. Available: ${SUBCOMMANDS.join(', ')}`);
|
|
63
|
+
}
|
|
64
|
+
await this.runNestedUpsert(suffix, args.id, flags);
|
|
47
65
|
return;
|
|
48
66
|
}
|
|
49
67
|
// Handle export action specially
|
|
@@ -60,12 +78,17 @@ export default class DunningRuns extends Command {
|
|
|
60
78
|
await this.runCamt053Import(flags);
|
|
61
79
|
return;
|
|
62
80
|
}
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
81
|
+
if (SERVER_IMPORTS.includes(args.action)) {
|
|
82
|
+
await this.runServerImport(args.action, args.id, flags);
|
|
83
|
+
return;
|
|
84
|
+
}
|
|
85
|
+
// 'import' used to name the CLI's create/update loop on every resource. It
|
|
86
|
+
// now names the API endpoint, which most resources do not have.
|
|
87
|
+
if (args.action === 'import' || args.action.startsWith('import-')) {
|
|
88
|
+
const suffix = args.action === 'import' ? '' : '-' + args.action.replace('import-', '');
|
|
89
|
+
const loops = args.action === 'import' ? HAS_UPSERT : NESTED_UPSERTS.includes(args.action.replace('import-', ''));
|
|
90
|
+
if (loops) {
|
|
91
|
+
this.error(`This resource has no import endpoint. Use: aderis dunning-runs upsert${suffix}${suffix ? ' <id>' : ''} --file data.json`);
|
|
69
92
|
}
|
|
70
93
|
}
|
|
71
94
|
const endpoint = ENDPOINTS[args.action];
|
|
@@ -380,7 +403,7 @@ export default class DunningRuns extends Command {
|
|
|
380
403
|
throw error;
|
|
381
404
|
}
|
|
382
405
|
}
|
|
383
|
-
async
|
|
406
|
+
async runUpsert(flags) {
|
|
384
407
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
385
408
|
if (!context)
|
|
386
409
|
this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
|
|
@@ -444,12 +467,12 @@ export default class DunningRuns extends Command {
|
|
|
444
467
|
items = [item];
|
|
445
468
|
}
|
|
446
469
|
else {
|
|
447
|
-
this.error('
|
|
470
|
+
this.error('Upsert requires --file, --data, or --set flags');
|
|
448
471
|
}
|
|
449
472
|
const createEndpoint = ENDPOINTS['create'];
|
|
450
473
|
const updateEndpoint = ENDPOINTS['update'];
|
|
451
474
|
if (!createEndpoint || !updateEndpoint) {
|
|
452
|
-
this.error('
|
|
475
|
+
this.error('Upsert requires both create and update endpoints');
|
|
453
476
|
}
|
|
454
477
|
// Helper to extract identifier from item (id, code, or xxxCode)
|
|
455
478
|
const getItemIdentifier = (item) => {
|
|
@@ -592,6 +615,117 @@ export default class DunningRuns extends Command {
|
|
|
592
615
|
this.log('');
|
|
593
616
|
this.log(`Summary: ${created} created, ${updated} updated, ${errors.length} failed`);
|
|
594
617
|
}
|
|
618
|
+
/**
|
|
619
|
+
* The API's own import: the whole array goes up in one request and comes
|
|
620
|
+
* back as an import run, which records what happened to every record. A bad
|
|
621
|
+
* record lands in errorLog and the rest are still applied, and the run stays
|
|
622
|
+
* readable afterwards with: aderis imports get <id>.
|
|
623
|
+
*/
|
|
624
|
+
async runServerImport(action, parentId, flags) {
|
|
625
|
+
const endpoint = ENDPOINTS[action];
|
|
626
|
+
if (!endpoint)
|
|
627
|
+
this.error(`Unknown action: ${action}. Available: ${SUBCOMMANDS.join(', ')}`);
|
|
628
|
+
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
629
|
+
if (!context)
|
|
630
|
+
this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
|
|
631
|
+
if (!hasCredentials(context))
|
|
632
|
+
this.error(missingCredentialsMessage(context));
|
|
633
|
+
let apiPath = endpoint.path;
|
|
634
|
+
if (endpoint.pathParams.length > 0) {
|
|
635
|
+
if (!parentId)
|
|
636
|
+
this.error(`Missing required argument: id. Usage: aderis dunning-runs ${action} <parent-id> --file data.json`);
|
|
637
|
+
apiPath = apiPath.replace(`{${endpoint.pathParams[0]}}`, parentId);
|
|
638
|
+
}
|
|
639
|
+
// The endpoint takes an array. A single object is wrapped, so importing
|
|
640
|
+
// one record reads the same as importing many.
|
|
641
|
+
let records = [];
|
|
642
|
+
if (flags.file) {
|
|
643
|
+
const fsModule = await import('node:fs');
|
|
644
|
+
try {
|
|
645
|
+
const content = JSON.parse(fsModule.readFileSync(flags.file, 'utf-8'));
|
|
646
|
+
records = Array.isArray(content) ? content : [content];
|
|
647
|
+
}
|
|
648
|
+
catch {
|
|
649
|
+
this.error(`Failed to read file: ${flags.file}`);
|
|
650
|
+
}
|
|
651
|
+
}
|
|
652
|
+
else if (flags.data) {
|
|
653
|
+
try {
|
|
654
|
+
const content = JSON.parse(flags.data);
|
|
655
|
+
records = Array.isArray(content) ? content : [content];
|
|
656
|
+
}
|
|
657
|
+
catch {
|
|
658
|
+
this.error('Invalid JSON in --data');
|
|
659
|
+
}
|
|
660
|
+
}
|
|
661
|
+
else {
|
|
662
|
+
this.error('Import requires --file or --data holding a JSON array of records');
|
|
663
|
+
}
|
|
664
|
+
if (records.length === 0)
|
|
665
|
+
this.error('Nothing to import: the input is an empty array');
|
|
666
|
+
const params = { format: 'json' };
|
|
667
|
+
if (flags.mode)
|
|
668
|
+
params.mode = flags.mode;
|
|
669
|
+
if (flags.reference)
|
|
670
|
+
params.reference = flags.reference;
|
|
671
|
+
if (flags.async)
|
|
672
|
+
params.async = true;
|
|
673
|
+
const headers = {};
|
|
674
|
+
if (flags['idempotency-key'])
|
|
675
|
+
headers['Idempotency-Key'] = flags['idempotency-key'];
|
|
676
|
+
if (flags['show-http-request']) {
|
|
677
|
+
const baseUrls = getBaseUrls(context.environment);
|
|
678
|
+
const queryString = '?' + Object.entries(params).map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(String(v))}`).join('&');
|
|
679
|
+
process.stderr.write(`\n${endpoint.method.toUpperCase()} ${baseUrls.api}${apiPath}${queryString}\n`);
|
|
680
|
+
process.stderr.write(`Body: [${records.length} record${records.length === 1 ? '' : 's'}]\n\n`);
|
|
681
|
+
}
|
|
682
|
+
try {
|
|
683
|
+
const response = await apiRequest(endpoint.method, apiPath, {
|
|
684
|
+
contextName: flags.context,
|
|
685
|
+
data: records,
|
|
686
|
+
headers,
|
|
687
|
+
params,
|
|
688
|
+
});
|
|
689
|
+
this.printImportRun(response.data, flags);
|
|
690
|
+
}
|
|
691
|
+
catch (error) {
|
|
692
|
+
if (error instanceof ApiError) {
|
|
693
|
+
this.error(`API Error (${error.status}): ${error.message}`);
|
|
694
|
+
}
|
|
695
|
+
throw error;
|
|
696
|
+
}
|
|
697
|
+
}
|
|
698
|
+
/** Renders an import run: its counts, then whatever the server refused. */
|
|
699
|
+
printImportRun(run, flags) {
|
|
700
|
+
if (flags.output === 'json') {
|
|
701
|
+
this.log(JSON.stringify(run, null, 2));
|
|
702
|
+
return;
|
|
703
|
+
}
|
|
704
|
+
const record = (run ?? {});
|
|
705
|
+
const count = (key) => (typeof record[key] === 'number' ? record[key] : 0);
|
|
706
|
+
const id = record.id ? String(record.id) : '';
|
|
707
|
+
this.log(`Import ${id} - ${String(record.status ?? 'UNKNOWN')}${record.async ? ' (background)' : ''}`);
|
|
708
|
+
this.log(` ${count('inputSize')} submitted, ${count('createdCount')} created, ${count('updatedCount')} updated, ${count('unchangedCount')} unchanged`);
|
|
709
|
+
if (count('errorCount') > 0)
|
|
710
|
+
this.log(` ${count('errorCount')} not applied: ${count('refusedCount')} refused, ${count('failedCount')} failed`);
|
|
711
|
+
if (count('warningCount') > 0)
|
|
712
|
+
this.log(` ${count('warningCount')} applied with a warning`);
|
|
713
|
+
// errorLog is keyed by the record's identifier, then by field name.
|
|
714
|
+
const errorLog = record.errorLog;
|
|
715
|
+
if (errorLog && Object.keys(errorLog).length > 0) {
|
|
716
|
+
this.log('');
|
|
717
|
+
for (const [key, fields] of Object.entries(errorLog)) {
|
|
718
|
+
for (const [field, messages] of Object.entries(fields ?? {})) {
|
|
719
|
+
for (const message of messages ?? [])
|
|
720
|
+
this.log(` ${key} ${field}: ${message}`);
|
|
721
|
+
}
|
|
722
|
+
}
|
|
723
|
+
}
|
|
724
|
+
if (record.async && id) {
|
|
725
|
+
this.log('');
|
|
726
|
+
this.log(`Follow it with: aderis imports get ${id}`);
|
|
727
|
+
}
|
|
728
|
+
}
|
|
595
729
|
async runExport(flags) {
|
|
596
730
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
597
731
|
if (!context)
|
|
@@ -770,9 +904,9 @@ export default class DunningRuns extends Command {
|
|
|
770
904
|
throw error;
|
|
771
905
|
}
|
|
772
906
|
}
|
|
773
|
-
async
|
|
907
|
+
async runNestedUpsert(suffix, parentId, flags) {
|
|
774
908
|
if (!parentId) {
|
|
775
|
-
this.error(`Missing required argument: id. Usage: aderis dunning-runs
|
|
909
|
+
this.error(`Missing required argument: id. Usage: aderis dunning-runs upsert-${suffix} <parent-id> --file data.json`);
|
|
776
910
|
}
|
|
777
911
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
778
912
|
if (!context)
|
|
@@ -837,12 +971,12 @@ export default class DunningRuns extends Command {
|
|
|
837
971
|
items = [item];
|
|
838
972
|
}
|
|
839
973
|
else {
|
|
840
|
-
this.error(
|
|
974
|
+
this.error('Upsert requires --file, --data, or --set flags');
|
|
841
975
|
}
|
|
842
976
|
const createEndpoint = ENDPOINTS[`create-${suffix}`];
|
|
843
977
|
const updateEndpoint = ENDPOINTS[`update-${suffix}`];
|
|
844
978
|
if (!createEndpoint || !updateEndpoint) {
|
|
845
|
-
this.error(`
|
|
979
|
+
this.error(`Upsert requires both create-${suffix} and update-${suffix} endpoints`);
|
|
846
980
|
}
|
|
847
981
|
// Build the base path with parent ID (first path param)
|
|
848
982
|
const firstParam = createEndpoint.pathParams[0];
|
|
@@ -27,10 +27,19 @@ export default class EmailTransactions 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 = [...["event-webhook", "list", "get"], ...(HAS_UPSERT ? ['upsert'] : []), ...(HAS_EXPORT ? ['export'] : []), ...NESTED_UPSERTS.map(n => `upsert-${n}`)];
|
|
10
13
|
const ENDPOINTS = {
|
|
11
14
|
'event-webhook': { method: 'POST', path: '/v1/email-transactions/event-webhook', summary: 'SendGrid delivery-event webhook (ECDSA signature-verified, no bearer token)', pathParams: [], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
|
|
12
15
|
'list': { method: 'GET', path: '/v1/email-transactions', summary: 'List email transactions for the current tenant', pathParams: [], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
|
|
@@ -25,7 +28,7 @@ export default class EmailTransactions extends Command {
|
|
|
25
28
|
};
|
|
26
29
|
static flags = {
|
|
27
30
|
context: Flags.string({ char: 'c', aliases: ['config'], env: 'ADERIS_CONTEXT', description: 'Context to use for this command, overriding the current context (alias: --config)' }),
|
|
28
|
-
output: Flags.string({ char: 'o', description: 'Output format (default: table for
|
|
31
|
+
output: Flags.string({ char: 'o', description: 'Output format (default: table for upsert, json for other commands)', options: ['json', 'table', 'csv'] }),
|
|
29
32
|
table: Flags.boolean({ char: 't', description: 'Output as table (shortcut for --output table)' }),
|
|
30
33
|
csv: Flags.boolean({ description: 'Output as CSV (shortcut for --output csv)' }),
|
|
31
34
|
data: Flags.string({ char: 'd', description: 'JSON data for request body' }),
|
|
@@ -45,11 +48,26 @@ export default class EmailTransactions extends Command {
|
|
|
45
48
|
};
|
|
46
49
|
async run() {
|
|
47
50
|
const { args, flags } = await this.parse(EmailTransactions);
|
|
48
|
-
//
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
51
|
+
// Bulk actions. 'import' is the API's own endpoint: one request, answered
|
|
52
|
+
// by a run that records what happened to every record. 'upsert' is the CLI
|
|
53
|
+
// looping create/update. A resource has one or the other, never both.
|
|
54
|
+
if (args.action === 'upsert') {
|
|
55
|
+
if (!HAS_UPSERT) {
|
|
56
|
+
this.error(SERVER_IMPORTS.includes('import')
|
|
57
|
+
? 'This resource is imported by the API. Use: aderis email-transactions import --file data.json'
|
|
58
|
+
: 'Upsert needs both a create and an update endpoint, which this resource does not have');
|
|
59
|
+
}
|
|
60
|
+
await this.runUpsert(flags);
|
|
61
|
+
return;
|
|
62
|
+
}
|
|
63
|
+
if (args.action.startsWith('upsert-')) {
|
|
64
|
+
const suffix = args.action.replace('upsert-', '');
|
|
65
|
+
if (!NESTED_UPSERTS.includes(suffix)) {
|
|
66
|
+
this.error(SERVER_IMPORTS.includes('import-' + suffix)
|
|
67
|
+
? `That resource is imported by the API. Use: aderis email-transactions import-${suffix} <id> --file data.json`
|
|
68
|
+
: `Unknown action: ${args.action}. Available: ${SUBCOMMANDS.join(', ')}`);
|
|
69
|
+
}
|
|
70
|
+
await this.runNestedUpsert(suffix, args.id, flags);
|
|
53
71
|
return;
|
|
54
72
|
}
|
|
55
73
|
// Handle export action specially
|
|
@@ -66,12 +84,17 @@ export default class EmailTransactions extends Command {
|
|
|
66
84
|
await this.runCamt053Import(flags);
|
|
67
85
|
return;
|
|
68
86
|
}
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
87
|
+
if (SERVER_IMPORTS.includes(args.action)) {
|
|
88
|
+
await this.runServerImport(args.action, args.id, flags);
|
|
89
|
+
return;
|
|
90
|
+
}
|
|
91
|
+
// 'import' used to name the CLI's create/update loop on every resource. It
|
|
92
|
+
// now names the API endpoint, which most resources do not have.
|
|
93
|
+
if (args.action === 'import' || args.action.startsWith('import-')) {
|
|
94
|
+
const suffix = args.action === 'import' ? '' : '-' + args.action.replace('import-', '');
|
|
95
|
+
const loops = args.action === 'import' ? HAS_UPSERT : NESTED_UPSERTS.includes(args.action.replace('import-', ''));
|
|
96
|
+
if (loops) {
|
|
97
|
+
this.error(`This resource has no import endpoint. Use: aderis email-transactions upsert${suffix}${suffix ? ' <id>' : ''} --file data.json`);
|
|
75
98
|
}
|
|
76
99
|
}
|
|
77
100
|
const endpoint = ENDPOINTS[args.action];
|
|
@@ -386,7 +409,7 @@ export default class EmailTransactions extends Command {
|
|
|
386
409
|
throw error;
|
|
387
410
|
}
|
|
388
411
|
}
|
|
389
|
-
async
|
|
412
|
+
async runUpsert(flags) {
|
|
390
413
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
391
414
|
if (!context)
|
|
392
415
|
this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
|
|
@@ -450,12 +473,12 @@ export default class EmailTransactions extends Command {
|
|
|
450
473
|
items = [item];
|
|
451
474
|
}
|
|
452
475
|
else {
|
|
453
|
-
this.error('
|
|
476
|
+
this.error('Upsert requires --file, --data, or --set flags');
|
|
454
477
|
}
|
|
455
478
|
const createEndpoint = ENDPOINTS['create'];
|
|
456
479
|
const updateEndpoint = ENDPOINTS['update'];
|
|
457
480
|
if (!createEndpoint || !updateEndpoint) {
|
|
458
|
-
this.error('
|
|
481
|
+
this.error('Upsert requires both create and update endpoints');
|
|
459
482
|
}
|
|
460
483
|
// Helper to extract identifier from item (id, code, or xxxCode)
|
|
461
484
|
const getItemIdentifier = (item) => {
|
|
@@ -598,6 +621,117 @@ export default class EmailTransactions extends Command {
|
|
|
598
621
|
this.log('');
|
|
599
622
|
this.log(`Summary: ${created} created, ${updated} updated, ${errors.length} failed`);
|
|
600
623
|
}
|
|
624
|
+
/**
|
|
625
|
+
* The API's own import: the whole array goes up in one request and comes
|
|
626
|
+
* back as an import run, which records what happened to every record. A bad
|
|
627
|
+
* record lands in errorLog and the rest are still applied, and the run stays
|
|
628
|
+
* readable afterwards with: aderis imports get <id>.
|
|
629
|
+
*/
|
|
630
|
+
async runServerImport(action, parentId, flags) {
|
|
631
|
+
const endpoint = ENDPOINTS[action];
|
|
632
|
+
if (!endpoint)
|
|
633
|
+
this.error(`Unknown action: ${action}. Available: ${SUBCOMMANDS.join(', ')}`);
|
|
634
|
+
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
635
|
+
if (!context)
|
|
636
|
+
this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
|
|
637
|
+
if (!hasCredentials(context))
|
|
638
|
+
this.error(missingCredentialsMessage(context));
|
|
639
|
+
let apiPath = endpoint.path;
|
|
640
|
+
if (endpoint.pathParams.length > 0) {
|
|
641
|
+
if (!parentId)
|
|
642
|
+
this.error(`Missing required argument: id. Usage: aderis email-transactions ${action} <parent-id> --file data.json`);
|
|
643
|
+
apiPath = apiPath.replace(`{${endpoint.pathParams[0]}}`, parentId);
|
|
644
|
+
}
|
|
645
|
+
// The endpoint takes an array. A single object is wrapped, so importing
|
|
646
|
+
// one record reads the same as importing many.
|
|
647
|
+
let records = [];
|
|
648
|
+
if (flags.file) {
|
|
649
|
+
const fsModule = await import('node:fs');
|
|
650
|
+
try {
|
|
651
|
+
const content = JSON.parse(fsModule.readFileSync(flags.file, 'utf-8'));
|
|
652
|
+
records = Array.isArray(content) ? content : [content];
|
|
653
|
+
}
|
|
654
|
+
catch {
|
|
655
|
+
this.error(`Failed to read file: ${flags.file}`);
|
|
656
|
+
}
|
|
657
|
+
}
|
|
658
|
+
else if (flags.data) {
|
|
659
|
+
try {
|
|
660
|
+
const content = JSON.parse(flags.data);
|
|
661
|
+
records = Array.isArray(content) ? content : [content];
|
|
662
|
+
}
|
|
663
|
+
catch {
|
|
664
|
+
this.error('Invalid JSON in --data');
|
|
665
|
+
}
|
|
666
|
+
}
|
|
667
|
+
else {
|
|
668
|
+
this.error('Import requires --file or --data holding a JSON array of records');
|
|
669
|
+
}
|
|
670
|
+
if (records.length === 0)
|
|
671
|
+
this.error('Nothing to import: the input is an empty array');
|
|
672
|
+
const params = { format: 'json' };
|
|
673
|
+
if (flags.mode)
|
|
674
|
+
params.mode = flags.mode;
|
|
675
|
+
if (flags.reference)
|
|
676
|
+
params.reference = flags.reference;
|
|
677
|
+
if (flags.async)
|
|
678
|
+
params.async = true;
|
|
679
|
+
const headers = {};
|
|
680
|
+
if (flags['idempotency-key'])
|
|
681
|
+
headers['Idempotency-Key'] = flags['idempotency-key'];
|
|
682
|
+
if (flags['show-http-request']) {
|
|
683
|
+
const baseUrls = getBaseUrls(context.environment);
|
|
684
|
+
const queryString = '?' + Object.entries(params).map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(String(v))}`).join('&');
|
|
685
|
+
process.stderr.write(`\n${endpoint.method.toUpperCase()} ${baseUrls.api}${apiPath}${queryString}\n`);
|
|
686
|
+
process.stderr.write(`Body: [${records.length} record${records.length === 1 ? '' : 's'}]\n\n`);
|
|
687
|
+
}
|
|
688
|
+
try {
|
|
689
|
+
const response = await apiRequest(endpoint.method, apiPath, {
|
|
690
|
+
contextName: flags.context,
|
|
691
|
+
data: records,
|
|
692
|
+
headers,
|
|
693
|
+
params,
|
|
694
|
+
});
|
|
695
|
+
this.printImportRun(response.data, flags);
|
|
696
|
+
}
|
|
697
|
+
catch (error) {
|
|
698
|
+
if (error instanceof ApiError) {
|
|
699
|
+
this.error(`API Error (${error.status}): ${error.message}`);
|
|
700
|
+
}
|
|
701
|
+
throw error;
|
|
702
|
+
}
|
|
703
|
+
}
|
|
704
|
+
/** Renders an import run: its counts, then whatever the server refused. */
|
|
705
|
+
printImportRun(run, flags) {
|
|
706
|
+
if (flags.output === 'json') {
|
|
707
|
+
this.log(JSON.stringify(run, null, 2));
|
|
708
|
+
return;
|
|
709
|
+
}
|
|
710
|
+
const record = (run ?? {});
|
|
711
|
+
const count = (key) => (typeof record[key] === 'number' ? record[key] : 0);
|
|
712
|
+
const id = record.id ? String(record.id) : '';
|
|
713
|
+
this.log(`Import ${id} - ${String(record.status ?? 'UNKNOWN')}${record.async ? ' (background)' : ''}`);
|
|
714
|
+
this.log(` ${count('inputSize')} submitted, ${count('createdCount')} created, ${count('updatedCount')} updated, ${count('unchangedCount')} unchanged`);
|
|
715
|
+
if (count('errorCount') > 0)
|
|
716
|
+
this.log(` ${count('errorCount')} not applied: ${count('refusedCount')} refused, ${count('failedCount')} failed`);
|
|
717
|
+
if (count('warningCount') > 0)
|
|
718
|
+
this.log(` ${count('warningCount')} applied with a warning`);
|
|
719
|
+
// errorLog is keyed by the record's identifier, then by field name.
|
|
720
|
+
const errorLog = record.errorLog;
|
|
721
|
+
if (errorLog && Object.keys(errorLog).length > 0) {
|
|
722
|
+
this.log('');
|
|
723
|
+
for (const [key, fields] of Object.entries(errorLog)) {
|
|
724
|
+
for (const [field, messages] of Object.entries(fields ?? {})) {
|
|
725
|
+
for (const message of messages ?? [])
|
|
726
|
+
this.log(` ${key} ${field}: ${message}`);
|
|
727
|
+
}
|
|
728
|
+
}
|
|
729
|
+
}
|
|
730
|
+
if (record.async && id) {
|
|
731
|
+
this.log('');
|
|
732
|
+
this.log(`Follow it with: aderis imports get ${id}`);
|
|
733
|
+
}
|
|
734
|
+
}
|
|
601
735
|
async runExport(flags) {
|
|
602
736
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
603
737
|
if (!context)
|
|
@@ -776,9 +910,9 @@ export default class EmailTransactions extends Command {
|
|
|
776
910
|
throw error;
|
|
777
911
|
}
|
|
778
912
|
}
|
|
779
|
-
async
|
|
913
|
+
async runNestedUpsert(suffix, parentId, flags) {
|
|
780
914
|
if (!parentId) {
|
|
781
|
-
this.error(`Missing required argument: id. Usage: aderis email-transactions
|
|
915
|
+
this.error(`Missing required argument: id. Usage: aderis email-transactions upsert-${suffix} <parent-id> --file data.json`);
|
|
782
916
|
}
|
|
783
917
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
784
918
|
if (!context)
|
|
@@ -843,12 +977,12 @@ export default class EmailTransactions extends Command {
|
|
|
843
977
|
items = [item];
|
|
844
978
|
}
|
|
845
979
|
else {
|
|
846
|
-
this.error(
|
|
980
|
+
this.error('Upsert requires --file, --data, or --set flags');
|
|
847
981
|
}
|
|
848
982
|
const createEndpoint = ENDPOINTS[`create-${suffix}`];
|
|
849
983
|
const updateEndpoint = ENDPOINTS[`update-${suffix}`];
|
|
850
984
|
if (!createEndpoint || !updateEndpoint) {
|
|
851
|
-
this.error(`
|
|
985
|
+
this.error(`Upsert requires both create-${suffix} and update-${suffix} endpoints`);
|
|
852
986
|
}
|
|
853
987
|
// Build the base path with parent ID (first path param)
|
|
854
988
|
const firstParam = createEndpoint.pathParams[0];
|
|
@@ -18,6 +18,8 @@ export default class Employees extends Command {
|
|
|
18
18
|
'payment-id': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
19
19
|
'note-id': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
20
20
|
'file-id': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
21
|
+
'salary-part-id': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
22
|
+
month: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
21
23
|
page: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
22
24
|
limit: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
23
25
|
include: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
@@ -31,10 +33,19 @@ export default class Employees extends Command {
|
|
|
31
33
|
'show-http-request': import("@oclif/core/interfaces").BooleanFlag<boolean>;
|
|
32
34
|
};
|
|
33
35
|
run(): Promise<void>;
|
|
34
|
-
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;
|
|
35
46
|
private runExport;
|
|
36
47
|
private runCamt053Import;
|
|
37
|
-
private
|
|
48
|
+
private runNestedUpsert;
|
|
38
49
|
private parseFilterValue;
|
|
39
50
|
/** The page line under a table: which page, how many, and any sums the API returned. */
|
|
40
51
|
private printPageSummary;
|