@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 = 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 = ["files"];
|
|
12
|
+
const SUBCOMMANDS = [...["list", "create", "preview", "get", "update", "delete", "regenerate", "replace", "fields-contributions", "fields-contributions-export", "approve", "mark-as-filed", "xml", "notices-dismiss", "notices-restore", "list-files", "create-files", "get-files", "update-files", "delete-files", "files-download", "list-payments", "create-payments", "contributions-exclude", "exclusions-restore"], ...(HAS_UPSERT ? ['upsert'] : []), ...(HAS_EXPORT ? ['export'] : []), ...NESTED_UPSERTS.map(n => `upsert-${n}`)];
|
|
10
13
|
const ENDPOINTS = {
|
|
11
14
|
'list': { method: 'GET', path: '/v1/vat-declarations', summary: 'List VAT reports (paginated)', pathParams: [], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
|
|
12
15
|
'create': { method: 'POST', path: '/v1/vat-declarations', summary: 'Create a VAT declaration report (always async-accepted)', pathParams: [], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
|
|
@@ -41,7 +44,7 @@ export default class VatDeclarations extends Command {
|
|
|
41
44
|
'<%= config.bin %> vat-declarations get <id>',
|
|
42
45
|
'<%= config.bin %> vat-declarations create --data \'{...}\'',
|
|
43
46
|
'<%= config.bin %> vat-declarations update <id> --set field=value',
|
|
44
|
-
'<%= config.bin %> vat-declarations
|
|
47
|
+
'<%= config.bin %> vat-declarations upsert --file data.json',
|
|
45
48
|
'<%= config.bin %> vat-declarations export --csv > vat-declarations.csv',
|
|
46
49
|
];
|
|
47
50
|
static args = {
|
|
@@ -50,7 +53,7 @@ export default class VatDeclarations extends Command {
|
|
|
50
53
|
};
|
|
51
54
|
static flags = {
|
|
52
55
|
context: Flags.string({ char: 'c', aliases: ['config'], env: 'ADERIS_CONTEXT', description: 'Context to use for this command, overriding the current context (alias: --config)' }),
|
|
53
|
-
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'] }),
|
|
54
57
|
table: Flags.boolean({ char: 't', description: 'Output as table (shortcut for --output table)' }),
|
|
55
58
|
csv: Flags.boolean({ description: 'Output as CSV (shortcut for --output csv)' }),
|
|
56
59
|
data: Flags.string({ char: 'd', description: 'JSON data for request body' }),
|
|
@@ -75,11 +78,26 @@ export default class VatDeclarations extends Command {
|
|
|
75
78
|
};
|
|
76
79
|
async run() {
|
|
77
80
|
const { args, flags } = await this.parse(VatDeclarations);
|
|
78
|
-
//
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
81
|
+
// Bulk actions. 'import' is the API's own endpoint: one request, answered
|
|
82
|
+
// by a run that records what happened to every record. 'upsert' is the CLI
|
|
83
|
+
// looping create/update. A resource has one or the other, never both.
|
|
84
|
+
if (args.action === 'upsert') {
|
|
85
|
+
if (!HAS_UPSERT) {
|
|
86
|
+
this.error(SERVER_IMPORTS.includes('import')
|
|
87
|
+
? 'This resource is imported by the API. Use: aderis vat-declarations import --file data.json'
|
|
88
|
+
: 'Upsert needs both a create and an update endpoint, which this resource does not have');
|
|
89
|
+
}
|
|
90
|
+
await this.runUpsert(flags);
|
|
91
|
+
return;
|
|
92
|
+
}
|
|
93
|
+
if (args.action.startsWith('upsert-')) {
|
|
94
|
+
const suffix = args.action.replace('upsert-', '');
|
|
95
|
+
if (!NESTED_UPSERTS.includes(suffix)) {
|
|
96
|
+
this.error(SERVER_IMPORTS.includes('import-' + suffix)
|
|
97
|
+
? `That resource is imported by the API. Use: aderis vat-declarations import-${suffix} <id> --file data.json`
|
|
98
|
+
: `Unknown action: ${args.action}. Available: ${SUBCOMMANDS.join(', ')}`);
|
|
99
|
+
}
|
|
100
|
+
await this.runNestedUpsert(suffix, args.id, flags);
|
|
83
101
|
return;
|
|
84
102
|
}
|
|
85
103
|
// Handle export action specially
|
|
@@ -96,12 +114,17 @@ export default class VatDeclarations extends Command {
|
|
|
96
114
|
await this.runCamt053Import(flags);
|
|
97
115
|
return;
|
|
98
116
|
}
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
117
|
+
if (SERVER_IMPORTS.includes(args.action)) {
|
|
118
|
+
await this.runServerImport(args.action, args.id, flags);
|
|
119
|
+
return;
|
|
120
|
+
}
|
|
121
|
+
// 'import' used to name the CLI's create/update loop on every resource. It
|
|
122
|
+
// now names the API endpoint, which most resources do not have.
|
|
123
|
+
if (args.action === 'import' || args.action.startsWith('import-')) {
|
|
124
|
+
const suffix = args.action === 'import' ? '' : '-' + args.action.replace('import-', '');
|
|
125
|
+
const loops = args.action === 'import' ? HAS_UPSERT : NESTED_UPSERTS.includes(args.action.replace('import-', ''));
|
|
126
|
+
if (loops) {
|
|
127
|
+
this.error(`This resource has no import endpoint. Use: aderis vat-declarations upsert${suffix}${suffix ? ' <id>' : ''} --file data.json`);
|
|
105
128
|
}
|
|
106
129
|
}
|
|
107
130
|
const endpoint = ENDPOINTS[args.action];
|
|
@@ -416,7 +439,7 @@ export default class VatDeclarations extends Command {
|
|
|
416
439
|
throw error;
|
|
417
440
|
}
|
|
418
441
|
}
|
|
419
|
-
async
|
|
442
|
+
async runUpsert(flags) {
|
|
420
443
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
421
444
|
if (!context)
|
|
422
445
|
this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
|
|
@@ -480,12 +503,12 @@ export default class VatDeclarations extends Command {
|
|
|
480
503
|
items = [item];
|
|
481
504
|
}
|
|
482
505
|
else {
|
|
483
|
-
this.error('
|
|
506
|
+
this.error('Upsert requires --file, --data, or --set flags');
|
|
484
507
|
}
|
|
485
508
|
const createEndpoint = ENDPOINTS['create'];
|
|
486
509
|
const updateEndpoint = ENDPOINTS['update'];
|
|
487
510
|
if (!createEndpoint || !updateEndpoint) {
|
|
488
|
-
this.error('
|
|
511
|
+
this.error('Upsert requires both create and update endpoints');
|
|
489
512
|
}
|
|
490
513
|
// Helper to extract identifier from item (id, code, or xxxCode)
|
|
491
514
|
const getItemIdentifier = (item) => {
|
|
@@ -628,6 +651,117 @@ export default class VatDeclarations extends Command {
|
|
|
628
651
|
this.log('');
|
|
629
652
|
this.log(`Summary: ${created} created, ${updated} updated, ${errors.length} failed`);
|
|
630
653
|
}
|
|
654
|
+
/**
|
|
655
|
+
* The API's own import: the whole array goes up in one request and comes
|
|
656
|
+
* back as an import run, which records what happened to every record. A bad
|
|
657
|
+
* record lands in errorLog and the rest are still applied, and the run stays
|
|
658
|
+
* readable afterwards with: aderis imports get <id>.
|
|
659
|
+
*/
|
|
660
|
+
async runServerImport(action, parentId, flags) {
|
|
661
|
+
const endpoint = ENDPOINTS[action];
|
|
662
|
+
if (!endpoint)
|
|
663
|
+
this.error(`Unknown action: ${action}. Available: ${SUBCOMMANDS.join(', ')}`);
|
|
664
|
+
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
665
|
+
if (!context)
|
|
666
|
+
this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
|
|
667
|
+
if (!hasCredentials(context))
|
|
668
|
+
this.error(missingCredentialsMessage(context));
|
|
669
|
+
let apiPath = endpoint.path;
|
|
670
|
+
if (endpoint.pathParams.length > 0) {
|
|
671
|
+
if (!parentId)
|
|
672
|
+
this.error(`Missing required argument: id. Usage: aderis vat-declarations ${action} <parent-id> --file data.json`);
|
|
673
|
+
apiPath = apiPath.replace(`{${endpoint.pathParams[0]}}`, parentId);
|
|
674
|
+
}
|
|
675
|
+
// The endpoint takes an array. A single object is wrapped, so importing
|
|
676
|
+
// one record reads the same as importing many.
|
|
677
|
+
let records = [];
|
|
678
|
+
if (flags.file) {
|
|
679
|
+
const fsModule = await import('node:fs');
|
|
680
|
+
try {
|
|
681
|
+
const content = JSON.parse(fsModule.readFileSync(flags.file, 'utf-8'));
|
|
682
|
+
records = Array.isArray(content) ? content : [content];
|
|
683
|
+
}
|
|
684
|
+
catch {
|
|
685
|
+
this.error(`Failed to read file: ${flags.file}`);
|
|
686
|
+
}
|
|
687
|
+
}
|
|
688
|
+
else if (flags.data) {
|
|
689
|
+
try {
|
|
690
|
+
const content = JSON.parse(flags.data);
|
|
691
|
+
records = Array.isArray(content) ? content : [content];
|
|
692
|
+
}
|
|
693
|
+
catch {
|
|
694
|
+
this.error('Invalid JSON in --data');
|
|
695
|
+
}
|
|
696
|
+
}
|
|
697
|
+
else {
|
|
698
|
+
this.error('Import requires --file or --data holding a JSON array of records');
|
|
699
|
+
}
|
|
700
|
+
if (records.length === 0)
|
|
701
|
+
this.error('Nothing to import: the input is an empty array');
|
|
702
|
+
const params = { format: 'json' };
|
|
703
|
+
if (flags.mode)
|
|
704
|
+
params.mode = flags.mode;
|
|
705
|
+
if (flags.reference)
|
|
706
|
+
params.reference = flags.reference;
|
|
707
|
+
if (flags.async)
|
|
708
|
+
params.async = true;
|
|
709
|
+
const headers = {};
|
|
710
|
+
if (flags['idempotency-key'])
|
|
711
|
+
headers['Idempotency-Key'] = flags['idempotency-key'];
|
|
712
|
+
if (flags['show-http-request']) {
|
|
713
|
+
const baseUrls = getBaseUrls(context.environment);
|
|
714
|
+
const queryString = '?' + Object.entries(params).map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(String(v))}`).join('&');
|
|
715
|
+
process.stderr.write(`\n${endpoint.method.toUpperCase()} ${baseUrls.api}${apiPath}${queryString}\n`);
|
|
716
|
+
process.stderr.write(`Body: [${records.length} record${records.length === 1 ? '' : 's'}]\n\n`);
|
|
717
|
+
}
|
|
718
|
+
try {
|
|
719
|
+
const response = await apiRequest(endpoint.method, apiPath, {
|
|
720
|
+
contextName: flags.context,
|
|
721
|
+
data: records,
|
|
722
|
+
headers,
|
|
723
|
+
params,
|
|
724
|
+
});
|
|
725
|
+
this.printImportRun(response.data, flags);
|
|
726
|
+
}
|
|
727
|
+
catch (error) {
|
|
728
|
+
if (error instanceof ApiError) {
|
|
729
|
+
this.error(`API Error (${error.status}): ${error.message}`);
|
|
730
|
+
}
|
|
731
|
+
throw error;
|
|
732
|
+
}
|
|
733
|
+
}
|
|
734
|
+
/** Renders an import run: its counts, then whatever the server refused. */
|
|
735
|
+
printImportRun(run, flags) {
|
|
736
|
+
if (flags.output === 'json') {
|
|
737
|
+
this.log(JSON.stringify(run, null, 2));
|
|
738
|
+
return;
|
|
739
|
+
}
|
|
740
|
+
const record = (run ?? {});
|
|
741
|
+
const count = (key) => (typeof record[key] === 'number' ? record[key] : 0);
|
|
742
|
+
const id = record.id ? String(record.id) : '';
|
|
743
|
+
this.log(`Import ${id} - ${String(record.status ?? 'UNKNOWN')}${record.async ? ' (background)' : ''}`);
|
|
744
|
+
this.log(` ${count('inputSize')} submitted, ${count('createdCount')} created, ${count('updatedCount')} updated, ${count('unchangedCount')} unchanged`);
|
|
745
|
+
if (count('errorCount') > 0)
|
|
746
|
+
this.log(` ${count('errorCount')} not applied: ${count('refusedCount')} refused, ${count('failedCount')} failed`);
|
|
747
|
+
if (count('warningCount') > 0)
|
|
748
|
+
this.log(` ${count('warningCount')} applied with a warning`);
|
|
749
|
+
// errorLog is keyed by the record's identifier, then by field name.
|
|
750
|
+
const errorLog = record.errorLog;
|
|
751
|
+
if (errorLog && Object.keys(errorLog).length > 0) {
|
|
752
|
+
this.log('');
|
|
753
|
+
for (const [key, fields] of Object.entries(errorLog)) {
|
|
754
|
+
for (const [field, messages] of Object.entries(fields ?? {})) {
|
|
755
|
+
for (const message of messages ?? [])
|
|
756
|
+
this.log(` ${key} ${field}: ${message}`);
|
|
757
|
+
}
|
|
758
|
+
}
|
|
759
|
+
}
|
|
760
|
+
if (record.async && id) {
|
|
761
|
+
this.log('');
|
|
762
|
+
this.log(`Follow it with: aderis imports get ${id}`);
|
|
763
|
+
}
|
|
764
|
+
}
|
|
631
765
|
async runExport(flags) {
|
|
632
766
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
633
767
|
if (!context)
|
|
@@ -806,9 +940,9 @@ export default class VatDeclarations extends Command {
|
|
|
806
940
|
throw error;
|
|
807
941
|
}
|
|
808
942
|
}
|
|
809
|
-
async
|
|
943
|
+
async runNestedUpsert(suffix, parentId, flags) {
|
|
810
944
|
if (!parentId) {
|
|
811
|
-
this.error(`Missing required argument: id. Usage: aderis vat-declarations
|
|
945
|
+
this.error(`Missing required argument: id. Usage: aderis vat-declarations upsert-${suffix} <parent-id> --file data.json`);
|
|
812
946
|
}
|
|
813
947
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
814
948
|
if (!context)
|
|
@@ -873,12 +1007,12 @@ export default class VatDeclarations extends Command {
|
|
|
873
1007
|
items = [item];
|
|
874
1008
|
}
|
|
875
1009
|
else {
|
|
876
|
-
this.error(
|
|
1010
|
+
this.error('Upsert requires --file, --data, or --set flags');
|
|
877
1011
|
}
|
|
878
1012
|
const createEndpoint = ENDPOINTS[`create-${suffix}`];
|
|
879
1013
|
const updateEndpoint = ENDPOINTS[`update-${suffix}`];
|
|
880
1014
|
if (!createEndpoint || !updateEndpoint) {
|
|
881
|
-
this.error(`
|
|
1015
|
+
this.error(`Upsert requires both create-${suffix} and update-${suffix} endpoints`);
|
|
882
1016
|
}
|
|
883
1017
|
// Build the base path with parent ID (first path param)
|
|
884
1018
|
const firstParam = createEndpoint.pathParams[0];
|
|
@@ -32,10 +32,19 @@ export default class VendorInvoices extends Command {
|
|
|
32
32
|
'show-http-request': import("@oclif/core/interfaces").BooleanFlag<boolean>;
|
|
33
33
|
};
|
|
34
34
|
run(): Promise<void>;
|
|
35
|
-
private
|
|
35
|
+
private runUpsert;
|
|
36
|
+
/**
|
|
37
|
+
* The API's own import: the whole array goes up in one request and comes
|
|
38
|
+
* back as an import run, which records what happened to every record. A bad
|
|
39
|
+
* record lands in errorLog and the rest are still applied, and the run stays
|
|
40
|
+
* readable afterwards with: aderis imports get <id>.
|
|
41
|
+
*/
|
|
42
|
+
private runServerImport;
|
|
43
|
+
/** Renders an import run: its counts, then whatever the server refused. */
|
|
44
|
+
private printImportRun;
|
|
36
45
|
private runExport;
|
|
37
46
|
private runCamt053Import;
|
|
38
|
-
private
|
|
47
|
+
private runNestedUpsert;
|
|
39
48
|
private parseFilterValue;
|
|
40
49
|
/** The page line under a table: which page, how many, and any sums the API returned. */
|
|
41
50
|
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 = ["line-items", "notes", "files", "payments"];
|
|
12
|
+
const SUBCOMMANDS = [...["list", "create", "get", "update", "delete", "payment-derivation", "beneficiary-check", "submit", "approve", "decline", "book", "rebuild-journal", "cancel", "change-vendor", "recalculate-payment-status", "validate", "create-line-items", "update-line-items", "delete-line-items", "list-notes", "create-notes", "get-notes", "update-notes", "delete-notes", "list-files", "create-files", "get-files", "update-files", "delete-files", "files-download", "list-payments", "create-payments", "get-payments", "update-payments", "delete-payments", "payments-approve", "payments-reopen", "payments-cancel", "create-offsets", "delete-offsets", "offset-candidates", "create-nettings", "delete-nettings", "netting-candidates"], ...(HAS_UPSERT ? ['upsert'] : []), ...(HAS_EXPORT ? ['export'] : []), ...NESTED_UPSERTS.map(n => `upsert-${n}`)];
|
|
10
13
|
const ENDPOINTS = {
|
|
11
14
|
'list': { method: 'GET', path: '/v1/vendor-invoices', summary: 'Get all vendor invoices with pagination', pathParams: [], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
|
|
12
15
|
'create': { method: 'POST', path: '/v1/vendor-invoices', summary: 'Create a new vendor invoice', pathParams: [], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: ['earlyPaymentDiscounts', 'totalAmountByTaxRate', 'files', 'notes', 'lineItems', 'tagIds', 'tagCodes', 'payments'] },
|
|
@@ -49,6 +52,9 @@ const ENDPOINTS = {
|
|
|
49
52
|
'create-offsets': { method: 'POST', path: '/v1/vendor-invoices/{vendorInvoiceId}/offsets', summary: 'Offset a prepayment or credit note against a vendor invoice', pathParams: ['vendorInvoiceId'], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
|
|
50
53
|
'delete-offsets': { method: 'DELETE', path: '/v1/vendor-invoices/{vendorInvoiceId}/offsets/{offsetId}', summary: 'Remove an offset of a prepayment or credit note from a vendor invoice', pathParams: ['vendorInvoiceId', 'offsetId'], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
|
|
51
54
|
'offset-candidates': { method: 'GET', path: '/v1/vendor-invoices/{vendorInvoiceId}/offset-candidates', summary: 'List the prepayments and credit notes that can be offset against a vendor invoice', pathParams: ['vendorInvoiceId'], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
|
|
55
|
+
'create-nettings': { method: 'POST', path: '/v1/vendor-invoices/{vendorInvoiceId}/nettings', summary: 'Net a sales invoice of the same business partner against a vendor invoice', pathParams: ['vendorInvoiceId'], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
|
|
56
|
+
'delete-nettings': { method: 'DELETE', path: '/v1/vendor-invoices/{vendorInvoiceId}/nettings/{offsetId}', summary: 'Remove a netting of a vendor invoice against a sales invoice', pathParams: ['vendorInvoiceId', 'offsetId'], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
|
|
57
|
+
'netting-candidates': { method: 'GET', path: '/v1/vendor-invoices/{vendorInvoiceId}/netting-candidates', summary: 'List the sales invoices that can be netted against a vendor invoice', pathParams: ['vendorInvoiceId'], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
|
|
52
58
|
};
|
|
53
59
|
export default class VendorInvoices extends Command {
|
|
54
60
|
static description = 'Manage vendor invoices';
|
|
@@ -57,7 +63,7 @@ export default class VendorInvoices extends Command {
|
|
|
57
63
|
'<%= config.bin %> vendor-invoices get <id>',
|
|
58
64
|
'<%= config.bin %> vendor-invoices create --data \'{...}\'',
|
|
59
65
|
'<%= config.bin %> vendor-invoices update <id> --set field=value',
|
|
60
|
-
'<%= config.bin %> vendor-invoices
|
|
66
|
+
'<%= config.bin %> vendor-invoices upsert --file data.json',
|
|
61
67
|
'<%= config.bin %> vendor-invoices export --csv > vendor-invoices.csv',
|
|
62
68
|
];
|
|
63
69
|
static args = {
|
|
@@ -66,7 +72,7 @@ export default class VendorInvoices extends Command {
|
|
|
66
72
|
};
|
|
67
73
|
static flags = {
|
|
68
74
|
context: Flags.string({ char: 'c', aliases: ['config'], env: 'ADERIS_CONTEXT', description: 'Context to use for this command, overriding the current context (alias: --config)' }),
|
|
69
|
-
output: Flags.string({ char: 'o', description: 'Output format (default: table for
|
|
75
|
+
output: Flags.string({ char: 'o', description: 'Output format (default: table for upsert, json for other commands)', options: ['json', 'table', 'csv'] }),
|
|
70
76
|
table: Flags.boolean({ char: 't', description: 'Output as table (shortcut for --output table)' }),
|
|
71
77
|
csv: Flags.boolean({ description: 'Output as CSV (shortcut for --output csv)' }),
|
|
72
78
|
data: Flags.string({ char: 'd', description: 'JSON data for request body' }),
|
|
@@ -91,11 +97,26 @@ export default class VendorInvoices extends Command {
|
|
|
91
97
|
};
|
|
92
98
|
async run() {
|
|
93
99
|
const { args, flags } = await this.parse(VendorInvoices);
|
|
94
|
-
//
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
100
|
+
// Bulk actions. 'import' is the API's own endpoint: one request, answered
|
|
101
|
+
// by a run that records what happened to every record. 'upsert' is the CLI
|
|
102
|
+
// looping create/update. A resource has one or the other, never both.
|
|
103
|
+
if (args.action === 'upsert') {
|
|
104
|
+
if (!HAS_UPSERT) {
|
|
105
|
+
this.error(SERVER_IMPORTS.includes('import')
|
|
106
|
+
? 'This resource is imported by the API. Use: aderis vendor-invoices import --file data.json'
|
|
107
|
+
: 'Upsert needs both a create and an update endpoint, which this resource does not have');
|
|
108
|
+
}
|
|
109
|
+
await this.runUpsert(flags);
|
|
110
|
+
return;
|
|
111
|
+
}
|
|
112
|
+
if (args.action.startsWith('upsert-')) {
|
|
113
|
+
const suffix = args.action.replace('upsert-', '');
|
|
114
|
+
if (!NESTED_UPSERTS.includes(suffix)) {
|
|
115
|
+
this.error(SERVER_IMPORTS.includes('import-' + suffix)
|
|
116
|
+
? `That resource is imported by the API. Use: aderis vendor-invoices import-${suffix} <id> --file data.json`
|
|
117
|
+
: `Unknown action: ${args.action}. Available: ${SUBCOMMANDS.join(', ')}`);
|
|
118
|
+
}
|
|
119
|
+
await this.runNestedUpsert(suffix, args.id, flags);
|
|
99
120
|
return;
|
|
100
121
|
}
|
|
101
122
|
// Handle export action specially
|
|
@@ -112,12 +133,17 @@ export default class VendorInvoices extends Command {
|
|
|
112
133
|
await this.runCamt053Import(flags);
|
|
113
134
|
return;
|
|
114
135
|
}
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
136
|
+
if (SERVER_IMPORTS.includes(args.action)) {
|
|
137
|
+
await this.runServerImport(args.action, args.id, flags);
|
|
138
|
+
return;
|
|
139
|
+
}
|
|
140
|
+
// 'import' used to name the CLI's create/update loop on every resource. It
|
|
141
|
+
// now names the API endpoint, which most resources do not have.
|
|
142
|
+
if (args.action === 'import' || args.action.startsWith('import-')) {
|
|
143
|
+
const suffix = args.action === 'import' ? '' : '-' + args.action.replace('import-', '');
|
|
144
|
+
const loops = args.action === 'import' ? HAS_UPSERT : NESTED_UPSERTS.includes(args.action.replace('import-', ''));
|
|
145
|
+
if (loops) {
|
|
146
|
+
this.error(`This resource has no import endpoint. Use: aderis vendor-invoices upsert${suffix}${suffix ? ' <id>' : ''} --file data.json`);
|
|
121
147
|
}
|
|
122
148
|
}
|
|
123
149
|
const endpoint = ENDPOINTS[args.action];
|
|
@@ -432,7 +458,7 @@ export default class VendorInvoices extends Command {
|
|
|
432
458
|
throw error;
|
|
433
459
|
}
|
|
434
460
|
}
|
|
435
|
-
async
|
|
461
|
+
async runUpsert(flags) {
|
|
436
462
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
437
463
|
if (!context)
|
|
438
464
|
this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
|
|
@@ -496,12 +522,12 @@ export default class VendorInvoices extends Command {
|
|
|
496
522
|
items = [item];
|
|
497
523
|
}
|
|
498
524
|
else {
|
|
499
|
-
this.error('
|
|
525
|
+
this.error('Upsert requires --file, --data, or --set flags');
|
|
500
526
|
}
|
|
501
527
|
const createEndpoint = ENDPOINTS['create'];
|
|
502
528
|
const updateEndpoint = ENDPOINTS['update'];
|
|
503
529
|
if (!createEndpoint || !updateEndpoint) {
|
|
504
|
-
this.error('
|
|
530
|
+
this.error('Upsert requires both create and update endpoints');
|
|
505
531
|
}
|
|
506
532
|
// Helper to extract identifier from item (id, code, or xxxCode)
|
|
507
533
|
const getItemIdentifier = (item) => {
|
|
@@ -644,6 +670,117 @@ export default class VendorInvoices extends Command {
|
|
|
644
670
|
this.log('');
|
|
645
671
|
this.log(`Summary: ${created} created, ${updated} updated, ${errors.length} failed`);
|
|
646
672
|
}
|
|
673
|
+
/**
|
|
674
|
+
* The API's own import: the whole array goes up in one request and comes
|
|
675
|
+
* back as an import run, which records what happened to every record. A bad
|
|
676
|
+
* record lands in errorLog and the rest are still applied, and the run stays
|
|
677
|
+
* readable afterwards with: aderis imports get <id>.
|
|
678
|
+
*/
|
|
679
|
+
async runServerImport(action, parentId, flags) {
|
|
680
|
+
const endpoint = ENDPOINTS[action];
|
|
681
|
+
if (!endpoint)
|
|
682
|
+
this.error(`Unknown action: ${action}. Available: ${SUBCOMMANDS.join(', ')}`);
|
|
683
|
+
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
684
|
+
if (!context)
|
|
685
|
+
this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
|
|
686
|
+
if (!hasCredentials(context))
|
|
687
|
+
this.error(missingCredentialsMessage(context));
|
|
688
|
+
let apiPath = endpoint.path;
|
|
689
|
+
if (endpoint.pathParams.length > 0) {
|
|
690
|
+
if (!parentId)
|
|
691
|
+
this.error(`Missing required argument: id. Usage: aderis vendor-invoices ${action} <parent-id> --file data.json`);
|
|
692
|
+
apiPath = apiPath.replace(`{${endpoint.pathParams[0]}}`, parentId);
|
|
693
|
+
}
|
|
694
|
+
// The endpoint takes an array. A single object is wrapped, so importing
|
|
695
|
+
// one record reads the same as importing many.
|
|
696
|
+
let records = [];
|
|
697
|
+
if (flags.file) {
|
|
698
|
+
const fsModule = await import('node:fs');
|
|
699
|
+
try {
|
|
700
|
+
const content = JSON.parse(fsModule.readFileSync(flags.file, 'utf-8'));
|
|
701
|
+
records = Array.isArray(content) ? content : [content];
|
|
702
|
+
}
|
|
703
|
+
catch {
|
|
704
|
+
this.error(`Failed to read file: ${flags.file}`);
|
|
705
|
+
}
|
|
706
|
+
}
|
|
707
|
+
else if (flags.data) {
|
|
708
|
+
try {
|
|
709
|
+
const content = JSON.parse(flags.data);
|
|
710
|
+
records = Array.isArray(content) ? content : [content];
|
|
711
|
+
}
|
|
712
|
+
catch {
|
|
713
|
+
this.error('Invalid JSON in --data');
|
|
714
|
+
}
|
|
715
|
+
}
|
|
716
|
+
else {
|
|
717
|
+
this.error('Import requires --file or --data holding a JSON array of records');
|
|
718
|
+
}
|
|
719
|
+
if (records.length === 0)
|
|
720
|
+
this.error('Nothing to import: the input is an empty array');
|
|
721
|
+
const params = { format: 'json' };
|
|
722
|
+
if (flags.mode)
|
|
723
|
+
params.mode = flags.mode;
|
|
724
|
+
if (flags.reference)
|
|
725
|
+
params.reference = flags.reference;
|
|
726
|
+
if (flags.async)
|
|
727
|
+
params.async = true;
|
|
728
|
+
const headers = {};
|
|
729
|
+
if (flags['idempotency-key'])
|
|
730
|
+
headers['Idempotency-Key'] = flags['idempotency-key'];
|
|
731
|
+
if (flags['show-http-request']) {
|
|
732
|
+
const baseUrls = getBaseUrls(context.environment);
|
|
733
|
+
const queryString = '?' + Object.entries(params).map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(String(v))}`).join('&');
|
|
734
|
+
process.stderr.write(`\n${endpoint.method.toUpperCase()} ${baseUrls.api}${apiPath}${queryString}\n`);
|
|
735
|
+
process.stderr.write(`Body: [${records.length} record${records.length === 1 ? '' : 's'}]\n\n`);
|
|
736
|
+
}
|
|
737
|
+
try {
|
|
738
|
+
const response = await apiRequest(endpoint.method, apiPath, {
|
|
739
|
+
contextName: flags.context,
|
|
740
|
+
data: records,
|
|
741
|
+
headers,
|
|
742
|
+
params,
|
|
743
|
+
});
|
|
744
|
+
this.printImportRun(response.data, flags);
|
|
745
|
+
}
|
|
746
|
+
catch (error) {
|
|
747
|
+
if (error instanceof ApiError) {
|
|
748
|
+
this.error(`API Error (${error.status}): ${error.message}`);
|
|
749
|
+
}
|
|
750
|
+
throw error;
|
|
751
|
+
}
|
|
752
|
+
}
|
|
753
|
+
/** Renders an import run: its counts, then whatever the server refused. */
|
|
754
|
+
printImportRun(run, flags) {
|
|
755
|
+
if (flags.output === 'json') {
|
|
756
|
+
this.log(JSON.stringify(run, null, 2));
|
|
757
|
+
return;
|
|
758
|
+
}
|
|
759
|
+
const record = (run ?? {});
|
|
760
|
+
const count = (key) => (typeof record[key] === 'number' ? record[key] : 0);
|
|
761
|
+
const id = record.id ? String(record.id) : '';
|
|
762
|
+
this.log(`Import ${id} - ${String(record.status ?? 'UNKNOWN')}${record.async ? ' (background)' : ''}`);
|
|
763
|
+
this.log(` ${count('inputSize')} submitted, ${count('createdCount')} created, ${count('updatedCount')} updated, ${count('unchangedCount')} unchanged`);
|
|
764
|
+
if (count('errorCount') > 0)
|
|
765
|
+
this.log(` ${count('errorCount')} not applied: ${count('refusedCount')} refused, ${count('failedCount')} failed`);
|
|
766
|
+
if (count('warningCount') > 0)
|
|
767
|
+
this.log(` ${count('warningCount')} applied with a warning`);
|
|
768
|
+
// errorLog is keyed by the record's identifier, then by field name.
|
|
769
|
+
const errorLog = record.errorLog;
|
|
770
|
+
if (errorLog && Object.keys(errorLog).length > 0) {
|
|
771
|
+
this.log('');
|
|
772
|
+
for (const [key, fields] of Object.entries(errorLog)) {
|
|
773
|
+
for (const [field, messages] of Object.entries(fields ?? {})) {
|
|
774
|
+
for (const message of messages ?? [])
|
|
775
|
+
this.log(` ${key} ${field}: ${message}`);
|
|
776
|
+
}
|
|
777
|
+
}
|
|
778
|
+
}
|
|
779
|
+
if (record.async && id) {
|
|
780
|
+
this.log('');
|
|
781
|
+
this.log(`Follow it with: aderis imports get ${id}`);
|
|
782
|
+
}
|
|
783
|
+
}
|
|
647
784
|
async runExport(flags) {
|
|
648
785
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
649
786
|
if (!context)
|
|
@@ -822,9 +959,9 @@ export default class VendorInvoices extends Command {
|
|
|
822
959
|
throw error;
|
|
823
960
|
}
|
|
824
961
|
}
|
|
825
|
-
async
|
|
962
|
+
async runNestedUpsert(suffix, parentId, flags) {
|
|
826
963
|
if (!parentId) {
|
|
827
|
-
this.error(`Missing required argument: id. Usage: aderis vendor-invoices
|
|
964
|
+
this.error(`Missing required argument: id. Usage: aderis vendor-invoices upsert-${suffix} <parent-id> --file data.json`);
|
|
828
965
|
}
|
|
829
966
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
830
967
|
if (!context)
|
|
@@ -889,12 +1026,12 @@ export default class VendorInvoices extends Command {
|
|
|
889
1026
|
items = [item];
|
|
890
1027
|
}
|
|
891
1028
|
else {
|
|
892
|
-
this.error(
|
|
1029
|
+
this.error('Upsert requires --file, --data, or --set flags');
|
|
893
1030
|
}
|
|
894
1031
|
const createEndpoint = ENDPOINTS[`create-${suffix}`];
|
|
895
1032
|
const updateEndpoint = ENDPOINTS[`update-${suffix}`];
|
|
896
1033
|
if (!createEndpoint || !updateEndpoint) {
|
|
897
|
-
this.error(`
|
|
1034
|
+
this.error(`Upsert requires both create-${suffix} and update-${suffix} endpoints`);
|
|
898
1035
|
}
|
|
899
1036
|
// Build the base path with parent ID (first path param)
|
|
900
1037
|
const firstParam = createEndpoint.pathParams[0];
|
|
@@ -27,10 +27,19 @@ export default class Webhooks 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;
|