@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.
Files changed (138) hide show
  1. package/dist/commands/access-groups.d.ts +11 -2
  2. package/dist/commands/access-groups.js +158 -24
  3. package/dist/commands/account-transaction-allocations.d.ts +11 -2
  4. package/dist/commands/account-transaction-allocations.js +157 -23
  5. package/dist/commands/account-transactions.d.ts +15 -2
  6. package/dist/commands/account-transactions.js +162 -24
  7. package/dist/commands/accounts.d.ts +11 -2
  8. package/dist/commands/accounts.js +158 -24
  9. package/dist/commands/agent-platform.d.ts +11 -3
  10. package/dist/commands/agent-platform.js +157 -32
  11. package/dist/commands/agent-runs.d.ts +11 -2
  12. package/dist/commands/agent-runs.js +157 -23
  13. package/dist/commands/analytics.d.ts +11 -2
  14. package/dist/commands/analytics.js +157 -23
  15. package/dist/commands/api-keys.d.ts +11 -2
  16. package/dist/commands/api-keys.js +157 -23
  17. package/dist/commands/async-jobs.d.ts +11 -2
  18. package/dist/commands/async-jobs.js +158 -24
  19. package/dist/commands/audit-log.d.ts +11 -2
  20. package/dist/commands/audit-log.js +157 -23
  21. package/dist/commands/bank-accounts.d.ts +11 -2
  22. package/dist/commands/bank-accounts.js +158 -24
  23. package/dist/commands/bank-integrations.d.ts +11 -2
  24. package/dist/commands/bank-integrations.js +158 -24
  25. package/dist/commands/business-partners.d.ts +11 -2
  26. package/dist/commands/business-partners.js +158 -24
  27. package/dist/commands/chat.d.ts +11 -2
  28. package/dist/commands/chat.js +158 -24
  29. package/dist/commands/credit-card-accounts.d.ts +11 -2
  30. package/dist/commands/credit-card-accounts.js +158 -24
  31. package/dist/commands/delivery-notes.d.ts +11 -2
  32. package/dist/commands/delivery-notes.js +158 -24
  33. package/dist/commands/dunning-configs.d.ts +11 -2
  34. package/dist/commands/dunning-configs.js +158 -24
  35. package/dist/commands/dunning-reminders.d.ts +11 -2
  36. package/dist/commands/dunning-reminders.js +157 -23
  37. package/dist/commands/dunning-runs.d.ts +11 -2
  38. package/dist/commands/dunning-runs.js +157 -23
  39. package/dist/commands/email-transactions.d.ts +11 -2
  40. package/dist/commands/email-transactions.js +157 -23
  41. package/dist/commands/employees.d.ts +13 -2
  42. package/dist/commands/employees.js +169 -24
  43. package/dist/commands/entity-configurations.d.ts +11 -2
  44. package/dist/commands/entity-configurations.js +157 -23
  45. package/dist/commands/event-mapping-rules.d.ts +56 -0
  46. package/dist/commands/event-mapping-rules.js +1324 -0
  47. package/dist/commands/event-processor-mappings.d.ts +11 -2
  48. package/dist/commands/event-processor-mappings.js +158 -24
  49. package/dist/commands/files.d.ts +11 -2
  50. package/dist/commands/files.js +158 -24
  51. package/dist/commands/health.d.ts +11 -2
  52. package/dist/commands/health.js +157 -23
  53. package/dist/commands/imports.d.ts +11 -2
  54. package/dist/commands/imports.js +157 -23
  55. package/dist/commands/inbox.d.ts +11 -2
  56. package/dist/commands/inbox.js +157 -23
  57. package/dist/commands/integration-identities.d.ts +11 -2
  58. package/dist/commands/integration-identities.js +157 -23
  59. package/dist/commands/integrations.d.ts +11 -2
  60. package/dist/commands/integrations.js +157 -23
  61. package/dist/commands/item-categories.d.ts +11 -2
  62. package/dist/commands/item-categories.js +158 -24
  63. package/dist/commands/items.d.ts +15 -2
  64. package/dist/commands/items.js +163 -24
  65. package/dist/commands/journal-lines.d.ts +11 -2
  66. package/dist/commands/journal-lines.js +157 -23
  67. package/dist/commands/journals.d.ts +15 -2
  68. package/dist/commands/journals.js +163 -24
  69. package/dist/commands/ledgers.d.ts +11 -2
  70. package/dist/commands/ledgers.js +158 -24
  71. package/dist/commands/my-account.d.ts +11 -2
  72. package/dist/commands/my-account.js +157 -23
  73. package/dist/commands/office-locations.d.ts +11 -2
  74. package/dist/commands/office-locations.js +158 -24
  75. package/dist/commands/payment-methods.d.ts +11 -2
  76. package/dist/commands/payment-methods.js +158 -24
  77. package/dist/commands/payment-runs.d.ts +11 -2
  78. package/dist/commands/payment-runs.js +158 -24
  79. package/dist/commands/payment-terms.d.ts +11 -2
  80. package/dist/commands/payment-terms.js +159 -25
  81. package/dist/commands/payments.d.ts +11 -2
  82. package/dist/commands/payments.js +158 -24
  83. package/dist/commands/payroll-runs.d.ts +11 -2
  84. package/dist/commands/payroll-runs.js +158 -24
  85. package/dist/commands/permissions.d.ts +11 -2
  86. package/dist/commands/permissions.js +157 -23
  87. package/dist/commands/price-lists.d.ts +15 -2
  88. package/dist/commands/price-lists.js +164 -24
  89. package/dist/commands/processor-mappings.d.ts +11 -2
  90. package/dist/commands/processor-mappings.js +158 -24
  91. package/dist/commands/processors.d.ts +11 -2
  92. package/dist/commands/processors.js +158 -24
  93. package/dist/commands/purchase-order-types.d.ts +11 -2
  94. package/dist/commands/purchase-order-types.js +158 -24
  95. package/dist/commands/purchase-orders.d.ts +11 -2
  96. package/dist/commands/purchase-orders.js +158 -24
  97. package/dist/commands/reports.d.ts +11 -2
  98. package/dist/commands/reports.js +157 -23
  99. package/dist/commands/roles.d.ts +11 -2
  100. package/dist/commands/roles.js +158 -24
  101. package/dist/commands/salary-types.d.ts +11 -2
  102. package/dist/commands/salary-types.js +158 -24
  103. package/dist/commands/sales-invoices.d.ts +11 -2
  104. package/dist/commands/sales-invoices.js +161 -24
  105. package/dist/commands/sales-orders.d.ts +11 -2
  106. package/dist/commands/sales-orders.js +158 -24
  107. package/dist/commands/saved-views.d.ts +11 -2
  108. package/dist/commands/saved-views.js +157 -23
  109. package/dist/commands/scheduled-processor-mappings.d.ts +11 -2
  110. package/dist/commands/scheduled-processor-mappings.js +158 -24
  111. package/dist/commands/schedules.d.ts +11 -2
  112. package/dist/commands/schedules.js +158 -24
  113. package/dist/commands/tags.d.ts +11 -2
  114. package/dist/commands/tags.js +158 -24
  115. package/dist/commands/tax-codes.d.ts +11 -2
  116. package/dist/commands/tax-codes.js +158 -24
  117. package/dist/commands/tax-matrix.d.ts +11 -2
  118. package/dist/commands/tax-matrix.js +158 -24
  119. package/dist/commands/templates.d.ts +11 -2
  120. package/dist/commands/templates.js +162 -24
  121. package/dist/commands/tenants.d.ts +11 -2
  122. package/dist/commands/tenants.js +158 -24
  123. package/dist/commands/tools.d.ts +11 -2
  124. package/dist/commands/tools.js +157 -23
  125. package/dist/commands/users.d.ts +11 -2
  126. package/dist/commands/users.js +158 -24
  127. package/dist/commands/vat-declarations.d.ts +11 -2
  128. package/dist/commands/vat-declarations.js +158 -24
  129. package/dist/commands/vendor-invoices.d.ts +11 -2
  130. package/dist/commands/vendor-invoices.js +161 -24
  131. package/dist/commands/webhooks.d.ts +11 -2
  132. package/dist/commands/webhooks.js +158 -24
  133. package/dist/commands/workflows.d.ts +11 -2
  134. package/dist/commands/workflows.js +157 -23
  135. package/dist/lib/api-client.d.ts +1 -0
  136. package/dist/lib/api-client.js +3 -0
  137. package/oclif.manifest.json +466 -162
  138. package/package.json +1 -1
@@ -1,13 +1,20 @@
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
- // Add 'import' action if both create and update exist
5
- const HAS_IMPORT = true;
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 NESTED_IMPORTS = [];
9
- const SUBCOMMANDS = [...["list", "create", "get", "update", "delete", "usage", "duplicate", "preview"], ...(HAS_IMPORT ? ['import'] : []), ...(HAS_EXPORT ? ['export'] : []), ...NESTED_IMPORTS.map(n => `import-${n}`)];
10
+ const SERVER_IMPORTS = [];
11
+ const NESTED_UPSERTS = [];
12
+ const SUBCOMMANDS = [...["rule-fields", "rule-order", "replace-rule", "delete-rule", "list", "create", "get", "update", "delete", "usage", "duplicate", "preview"], ...(HAS_UPSERT ? ['upsert'] : []), ...(HAS_EXPORT ? ['export'] : []), ...NESTED_UPSERTS.map(n => `upsert-${n}`)];
10
13
  const ENDPOINTS = {
14
+ 'rule-fields': { method: 'GET', path: '/v1/templates/rule-fields', summary: 'List the fields a TEXT module’s template rules may test', pathParams: [], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
15
+ 'rule-order': { method: 'POST', path: '/v1/templates/rule-order', summary: 'Order the template rules of a TEXT module', pathParams: [], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: ['templateIds'] },
16
+ 'replace-rule': { method: 'PUT', path: '/v1/templates/{id}/rule', summary: 'Set the rule of a TEXT template', pathParams: ['id'], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
17
+ 'delete-rule': { method: 'DELETE', path: '/v1/templates/{id}/rule', summary: 'Remove the rule of a template', pathParams: ['id'], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
11
18
  'list': { method: 'GET', path: '/v1/templates', summary: 'Get all templates with pagination', pathParams: [], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
12
19
  'create': { method: 'POST', path: '/v1/templates', summary: 'Create a new template', pathParams: [], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: ['includes'] },
13
20
  'get': { method: 'GET', path: '/v1/templates/{id}', summary: 'Get a template by ID', pathParams: ['id'], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
@@ -24,7 +31,7 @@ export default class Templates extends Command {
24
31
  '<%= config.bin %> templates get <id>',
25
32
  '<%= config.bin %> templates create --data \'{...}\'',
26
33
  '<%= config.bin %> templates update <id> --set field=value',
27
- '<%= config.bin %> templates import --file data.json',
34
+ '<%= config.bin %> templates upsert --file data.json',
28
35
  '<%= config.bin %> templates export --csv > templates.csv',
29
36
  ];
30
37
  static args = {
@@ -33,7 +40,7 @@ export default class Templates extends Command {
33
40
  };
34
41
  static flags = {
35
42
  context: Flags.string({ char: 'c', aliases: ['config'], env: 'ADERIS_CONTEXT', description: 'Context to use for this command, overriding the current context (alias: --config)' }),
36
- output: Flags.string({ char: 'o', description: 'Output format (default: table for import, json for other commands)', options: ['json', 'table', 'csv'] }),
43
+ output: Flags.string({ char: 'o', description: 'Output format (default: table for upsert, json for other commands)', options: ['json', 'table', 'csv'] }),
37
44
  table: Flags.boolean({ char: 't', description: 'Output as table (shortcut for --output table)' }),
38
45
  csv: Flags.boolean({ description: 'Output as CSV (shortcut for --output csv)' }),
39
46
  data: Flags.string({ char: 'd', description: 'JSON data for request body' }),
@@ -53,11 +60,26 @@ export default class Templates extends Command {
53
60
  };
54
61
  async run() {
55
62
  const { args, flags } = await this.parse(Templates);
56
- // Handle import action specially
57
- if (args.action === 'import') {
58
- if (!HAS_IMPORT)
59
- this.error('Import not available for this resource');
60
- await this.runImport(flags);
63
+ // Bulk actions. 'import' is the API's own endpoint: one request, answered
64
+ // by a run that records what happened to every record. 'upsert' is the CLI
65
+ // looping create/update. A resource has one or the other, never both.
66
+ if (args.action === 'upsert') {
67
+ if (!HAS_UPSERT) {
68
+ this.error(SERVER_IMPORTS.includes('import')
69
+ ? 'This resource is imported by the API. Use: aderis templates import --file data.json'
70
+ : 'Upsert needs both a create and an update endpoint, which this resource does not have');
71
+ }
72
+ await this.runUpsert(flags);
73
+ return;
74
+ }
75
+ if (args.action.startsWith('upsert-')) {
76
+ const suffix = args.action.replace('upsert-', '');
77
+ if (!NESTED_UPSERTS.includes(suffix)) {
78
+ this.error(SERVER_IMPORTS.includes('import-' + suffix)
79
+ ? `That resource is imported by the API. Use: aderis templates import-${suffix} <id> --file data.json`
80
+ : `Unknown action: ${args.action}. Available: ${SUBCOMMANDS.join(', ')}`);
81
+ }
82
+ await this.runNestedUpsert(suffix, args.id, flags);
61
83
  return;
62
84
  }
63
85
  // Handle export action specially
@@ -74,12 +96,17 @@ export default class Templates extends Command {
74
96
  await this.runCamt053Import(flags);
75
97
  return;
76
98
  }
77
- // Handle nested resource imports (e.g., import-prices)
78
- if (args.action.startsWith('import-')) {
79
- const suffix = args.action.replace('import-', '');
80
- if (NESTED_IMPORTS.includes(suffix)) {
81
- await this.runNestedImport(suffix, args.id, flags);
82
- return;
99
+ if (SERVER_IMPORTS.includes(args.action)) {
100
+ await this.runServerImport(args.action, args.id, flags);
101
+ return;
102
+ }
103
+ // 'import' used to name the CLI's create/update loop on every resource. It
104
+ // now names the API endpoint, which most resources do not have.
105
+ if (args.action === 'import' || args.action.startsWith('import-')) {
106
+ const suffix = args.action === 'import' ? '' : '-' + args.action.replace('import-', '');
107
+ const loops = args.action === 'import' ? HAS_UPSERT : NESTED_UPSERTS.includes(args.action.replace('import-', ''));
108
+ if (loops) {
109
+ this.error(`This resource has no import endpoint. Use: aderis templates upsert${suffix}${suffix ? ' <id>' : ''} --file data.json`);
83
110
  }
84
111
  }
85
112
  const endpoint = ENDPOINTS[args.action];
@@ -394,7 +421,7 @@ export default class Templates extends Command {
394
421
  throw error;
395
422
  }
396
423
  }
397
- async runImport(flags) {
424
+ async runUpsert(flags) {
398
425
  const context = flags.context ? getContext(flags.context) : getCurrentContext();
399
426
  if (!context)
400
427
  this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
@@ -458,12 +485,12 @@ export default class Templates extends Command {
458
485
  items = [item];
459
486
  }
460
487
  else {
461
- this.error('Import requires --file, --data, or --set flags');
488
+ this.error('Upsert requires --file, --data, or --set flags');
462
489
  }
463
490
  const createEndpoint = ENDPOINTS['create'];
464
491
  const updateEndpoint = ENDPOINTS['update'];
465
492
  if (!createEndpoint || !updateEndpoint) {
466
- this.error('Import requires both create and update endpoints');
493
+ this.error('Upsert requires both create and update endpoints');
467
494
  }
468
495
  // Helper to extract identifier from item (id, code, or xxxCode)
469
496
  const getItemIdentifier = (item) => {
@@ -606,6 +633,117 @@ export default class Templates extends Command {
606
633
  this.log('');
607
634
  this.log(`Summary: ${created} created, ${updated} updated, ${errors.length} failed`);
608
635
  }
636
+ /**
637
+ * The API's own import: the whole array goes up in one request and comes
638
+ * back as an import run, which records what happened to every record. A bad
639
+ * record lands in errorLog and the rest are still applied, and the run stays
640
+ * readable afterwards with: aderis imports get <id>.
641
+ */
642
+ async runServerImport(action, parentId, flags) {
643
+ const endpoint = ENDPOINTS[action];
644
+ if (!endpoint)
645
+ this.error(`Unknown action: ${action}. Available: ${SUBCOMMANDS.join(', ')}`);
646
+ const context = flags.context ? getContext(flags.context) : getCurrentContext();
647
+ if (!context)
648
+ this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
649
+ if (!hasCredentials(context))
650
+ this.error(missingCredentialsMessage(context));
651
+ let apiPath = endpoint.path;
652
+ if (endpoint.pathParams.length > 0) {
653
+ if (!parentId)
654
+ this.error(`Missing required argument: id. Usage: aderis templates ${action} <parent-id> --file data.json`);
655
+ apiPath = apiPath.replace(`{${endpoint.pathParams[0]}}`, parentId);
656
+ }
657
+ // The endpoint takes an array. A single object is wrapped, so importing
658
+ // one record reads the same as importing many.
659
+ let records = [];
660
+ if (flags.file) {
661
+ const fsModule = await import('node:fs');
662
+ try {
663
+ const content = JSON.parse(fsModule.readFileSync(flags.file, 'utf-8'));
664
+ records = Array.isArray(content) ? content : [content];
665
+ }
666
+ catch {
667
+ this.error(`Failed to read file: ${flags.file}`);
668
+ }
669
+ }
670
+ else if (flags.data) {
671
+ try {
672
+ const content = JSON.parse(flags.data);
673
+ records = Array.isArray(content) ? content : [content];
674
+ }
675
+ catch {
676
+ this.error('Invalid JSON in --data');
677
+ }
678
+ }
679
+ else {
680
+ this.error('Import requires --file or --data holding a JSON array of records');
681
+ }
682
+ if (records.length === 0)
683
+ this.error('Nothing to import: the input is an empty array');
684
+ const params = { format: 'json' };
685
+ if (flags.mode)
686
+ params.mode = flags.mode;
687
+ if (flags.reference)
688
+ params.reference = flags.reference;
689
+ if (flags.async)
690
+ params.async = true;
691
+ const headers = {};
692
+ if (flags['idempotency-key'])
693
+ headers['Idempotency-Key'] = flags['idempotency-key'];
694
+ if (flags['show-http-request']) {
695
+ const baseUrls = getBaseUrls(context.environment);
696
+ const queryString = '?' + Object.entries(params).map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(String(v))}`).join('&');
697
+ process.stderr.write(`\n${endpoint.method.toUpperCase()} ${baseUrls.api}${apiPath}${queryString}\n`);
698
+ process.stderr.write(`Body: [${records.length} record${records.length === 1 ? '' : 's'}]\n\n`);
699
+ }
700
+ try {
701
+ const response = await apiRequest(endpoint.method, apiPath, {
702
+ contextName: flags.context,
703
+ data: records,
704
+ headers,
705
+ params,
706
+ });
707
+ this.printImportRun(response.data, flags);
708
+ }
709
+ catch (error) {
710
+ if (error instanceof ApiError) {
711
+ this.error(`API Error (${error.status}): ${error.message}`);
712
+ }
713
+ throw error;
714
+ }
715
+ }
716
+ /** Renders an import run: its counts, then whatever the server refused. */
717
+ printImportRun(run, flags) {
718
+ if (flags.output === 'json') {
719
+ this.log(JSON.stringify(run, null, 2));
720
+ return;
721
+ }
722
+ const record = (run ?? {});
723
+ const count = (key) => (typeof record[key] === 'number' ? record[key] : 0);
724
+ const id = record.id ? String(record.id) : '';
725
+ this.log(`Import ${id} - ${String(record.status ?? 'UNKNOWN')}${record.async ? ' (background)' : ''}`);
726
+ this.log(` ${count('inputSize')} submitted, ${count('createdCount')} created, ${count('updatedCount')} updated, ${count('unchangedCount')} unchanged`);
727
+ if (count('errorCount') > 0)
728
+ this.log(` ${count('errorCount')} not applied: ${count('refusedCount')} refused, ${count('failedCount')} failed`);
729
+ if (count('warningCount') > 0)
730
+ this.log(` ${count('warningCount')} applied with a warning`);
731
+ // errorLog is keyed by the record's identifier, then by field name.
732
+ const errorLog = record.errorLog;
733
+ if (errorLog && Object.keys(errorLog).length > 0) {
734
+ this.log('');
735
+ for (const [key, fields] of Object.entries(errorLog)) {
736
+ for (const [field, messages] of Object.entries(fields ?? {})) {
737
+ for (const message of messages ?? [])
738
+ this.log(` ${key} ${field}: ${message}`);
739
+ }
740
+ }
741
+ }
742
+ if (record.async && id) {
743
+ this.log('');
744
+ this.log(`Follow it with: aderis imports get ${id}`);
745
+ }
746
+ }
609
747
  async runExport(flags) {
610
748
  const context = flags.context ? getContext(flags.context) : getCurrentContext();
611
749
  if (!context)
@@ -784,9 +922,9 @@ export default class Templates extends Command {
784
922
  throw error;
785
923
  }
786
924
  }
787
- async runNestedImport(suffix, parentId, flags) {
925
+ async runNestedUpsert(suffix, parentId, flags) {
788
926
  if (!parentId) {
789
- this.error(`Missing required argument: id. Usage: aderis templates import-${suffix} <parent-id> --file data.json`);
927
+ this.error(`Missing required argument: id. Usage: aderis templates upsert-${suffix} <parent-id> --file data.json`);
790
928
  }
791
929
  const context = flags.context ? getContext(flags.context) : getCurrentContext();
792
930
  if (!context)
@@ -851,12 +989,12 @@ export default class Templates extends Command {
851
989
  items = [item];
852
990
  }
853
991
  else {
854
- this.error(`Import requires --file, --data, or --set flags`);
992
+ this.error('Upsert requires --file, --data, or --set flags');
855
993
  }
856
994
  const createEndpoint = ENDPOINTS[`create-${suffix}`];
857
995
  const updateEndpoint = ENDPOINTS[`update-${suffix}`];
858
996
  if (!createEndpoint || !updateEndpoint) {
859
- this.error(`Import requires both create-${suffix} and update-${suffix} endpoints`);
997
+ this.error(`Upsert requires both create-${suffix} and update-${suffix} endpoints`);
860
998
  }
861
999
  // Build the base path with parent ID (first path param)
862
1000
  const firstParam = createEndpoint.pathParams[0];
@@ -27,10 +27,19 @@ export default class Tenants extends Command {
27
27
  'show-http-request': import("@oclif/core/interfaces").BooleanFlag<boolean>;
28
28
  };
29
29
  run(): Promise<void>;
30
- private runImport;
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 runNestedImport;
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
- // Add 'import' action if both create and update exist
5
- const HAS_IMPORT = true;
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 NESTED_IMPORTS = [];
9
- const SUBCOMMANDS = [...["list", "create", "get", "update", "delete", "logo", "icon", "update-identity-provider"], ...(HAS_IMPORT ? ['import'] : []), ...(HAS_EXPORT ? ['export'] : []), ...NESTED_IMPORTS.map(n => `import-${n}`)];
10
+ const SERVER_IMPORTS = [];
11
+ const NESTED_UPSERTS = [];
12
+ const SUBCOMMANDS = [...["list", "create", "get", "update", "delete", "logo", "icon", "update-identity-provider"], ...(HAS_UPSERT ? ['upsert'] : []), ...(HAS_EXPORT ? ['export'] : []), ...NESTED_UPSERTS.map(n => `upsert-${n}`)];
10
13
  const ENDPOINTS = {
11
14
  'list': { method: 'GET', path: '/v1/tenants', summary: 'Get all tenants with pagination (admin only)', pathParams: [], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
12
15
  'create': { method: 'POST', path: '/v1/tenants', summary: 'Create a new tenant (admin only)', pathParams: [], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: ['supportedLocales', 'allowedSenders', 'salesInvoiceRecipientCc', 'salesInvoiceRecipientBcc', 'salesOrderRecipientCc', 'salesOrderRecipientBcc', 'deliveryNoteRecipientCc', 'deliveryNoteRecipientBcc'] },
@@ -24,7 +27,7 @@ export default class Tenants extends Command {
24
27
  '<%= config.bin %> tenants get <id>',
25
28
  '<%= config.bin %> tenants create --data \'{...}\'',
26
29
  '<%= config.bin %> tenants update <id> --set field=value',
27
- '<%= config.bin %> tenants import --file data.json',
30
+ '<%= config.bin %> tenants upsert --file data.json',
28
31
  '<%= config.bin %> tenants export --csv > tenants.csv',
29
32
  ];
30
33
  static args = {
@@ -33,7 +36,7 @@ export default class Tenants extends Command {
33
36
  };
34
37
  static flags = {
35
38
  context: Flags.string({ char: 'c', aliases: ['config'], env: 'ADERIS_CONTEXT', description: 'Context to use for this command, overriding the current context (alias: --config)' }),
36
- output: Flags.string({ char: 'o', description: 'Output format (default: table for import, json for other commands)', options: ['json', 'table', 'csv'] }),
39
+ output: Flags.string({ char: 'o', description: 'Output format (default: table for upsert, json for other commands)', options: ['json', 'table', 'csv'] }),
37
40
  table: Flags.boolean({ char: 't', description: 'Output as table (shortcut for --output table)' }),
38
41
  csv: Flags.boolean({ description: 'Output as CSV (shortcut for --output csv)' }),
39
42
  data: Flags.string({ char: 'd', description: 'JSON data for request body' }),
@@ -53,11 +56,26 @@ export default class Tenants extends Command {
53
56
  };
54
57
  async run() {
55
58
  const { args, flags } = await this.parse(Tenants);
56
- // Handle import action specially
57
- if (args.action === 'import') {
58
- if (!HAS_IMPORT)
59
- this.error('Import not available for this resource');
60
- await this.runImport(flags);
59
+ // Bulk actions. 'import' is the API's own endpoint: one request, answered
60
+ // by a run that records what happened to every record. 'upsert' is the CLI
61
+ // looping create/update. A resource has one or the other, never both.
62
+ if (args.action === 'upsert') {
63
+ if (!HAS_UPSERT) {
64
+ this.error(SERVER_IMPORTS.includes('import')
65
+ ? 'This resource is imported by the API. Use: aderis tenants import --file data.json'
66
+ : 'Upsert needs both a create and an update endpoint, which this resource does not have');
67
+ }
68
+ await this.runUpsert(flags);
69
+ return;
70
+ }
71
+ if (args.action.startsWith('upsert-')) {
72
+ const suffix = args.action.replace('upsert-', '');
73
+ if (!NESTED_UPSERTS.includes(suffix)) {
74
+ this.error(SERVER_IMPORTS.includes('import-' + suffix)
75
+ ? `That resource is imported by the API. Use: aderis tenants import-${suffix} <id> --file data.json`
76
+ : `Unknown action: ${args.action}. Available: ${SUBCOMMANDS.join(', ')}`);
77
+ }
78
+ await this.runNestedUpsert(suffix, args.id, flags);
61
79
  return;
62
80
  }
63
81
  // Handle export action specially
@@ -74,12 +92,17 @@ export default class Tenants extends Command {
74
92
  await this.runCamt053Import(flags);
75
93
  return;
76
94
  }
77
- // Handle nested resource imports (e.g., import-prices)
78
- if (args.action.startsWith('import-')) {
79
- const suffix = args.action.replace('import-', '');
80
- if (NESTED_IMPORTS.includes(suffix)) {
81
- await this.runNestedImport(suffix, args.id, flags);
82
- return;
95
+ if (SERVER_IMPORTS.includes(args.action)) {
96
+ await this.runServerImport(args.action, args.id, flags);
97
+ return;
98
+ }
99
+ // 'import' used to name the CLI's create/update loop on every resource. It
100
+ // now names the API endpoint, which most resources do not have.
101
+ if (args.action === 'import' || args.action.startsWith('import-')) {
102
+ const suffix = args.action === 'import' ? '' : '-' + args.action.replace('import-', '');
103
+ const loops = args.action === 'import' ? HAS_UPSERT : NESTED_UPSERTS.includes(args.action.replace('import-', ''));
104
+ if (loops) {
105
+ this.error(`This resource has no import endpoint. Use: aderis tenants upsert${suffix}${suffix ? ' <id>' : ''} --file data.json`);
83
106
  }
84
107
  }
85
108
  const endpoint = ENDPOINTS[args.action];
@@ -394,7 +417,7 @@ export default class Tenants extends Command {
394
417
  throw error;
395
418
  }
396
419
  }
397
- async runImport(flags) {
420
+ async runUpsert(flags) {
398
421
  const context = flags.context ? getContext(flags.context) : getCurrentContext();
399
422
  if (!context)
400
423
  this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
@@ -458,12 +481,12 @@ export default class Tenants extends Command {
458
481
  items = [item];
459
482
  }
460
483
  else {
461
- this.error('Import requires --file, --data, or --set flags');
484
+ this.error('Upsert requires --file, --data, or --set flags');
462
485
  }
463
486
  const createEndpoint = ENDPOINTS['create'];
464
487
  const updateEndpoint = ENDPOINTS['update'];
465
488
  if (!createEndpoint || !updateEndpoint) {
466
- this.error('Import requires both create and update endpoints');
489
+ this.error('Upsert requires both create and update endpoints');
467
490
  }
468
491
  // Helper to extract identifier from item (id, code, or xxxCode)
469
492
  const getItemIdentifier = (item) => {
@@ -606,6 +629,117 @@ export default class Tenants extends Command {
606
629
  this.log('');
607
630
  this.log(`Summary: ${created} created, ${updated} updated, ${errors.length} failed`);
608
631
  }
632
+ /**
633
+ * The API's own import: the whole array goes up in one request and comes
634
+ * back as an import run, which records what happened to every record. A bad
635
+ * record lands in errorLog and the rest are still applied, and the run stays
636
+ * readable afterwards with: aderis imports get <id>.
637
+ */
638
+ async runServerImport(action, parentId, flags) {
639
+ const endpoint = ENDPOINTS[action];
640
+ if (!endpoint)
641
+ this.error(`Unknown action: ${action}. Available: ${SUBCOMMANDS.join(', ')}`);
642
+ const context = flags.context ? getContext(flags.context) : getCurrentContext();
643
+ if (!context)
644
+ this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
645
+ if (!hasCredentials(context))
646
+ this.error(missingCredentialsMessage(context));
647
+ let apiPath = endpoint.path;
648
+ if (endpoint.pathParams.length > 0) {
649
+ if (!parentId)
650
+ this.error(`Missing required argument: id. Usage: aderis tenants ${action} <parent-id> --file data.json`);
651
+ apiPath = apiPath.replace(`{${endpoint.pathParams[0]}}`, parentId);
652
+ }
653
+ // The endpoint takes an array. A single object is wrapped, so importing
654
+ // one record reads the same as importing many.
655
+ let records = [];
656
+ if (flags.file) {
657
+ const fsModule = await import('node:fs');
658
+ try {
659
+ const content = JSON.parse(fsModule.readFileSync(flags.file, 'utf-8'));
660
+ records = Array.isArray(content) ? content : [content];
661
+ }
662
+ catch {
663
+ this.error(`Failed to read file: ${flags.file}`);
664
+ }
665
+ }
666
+ else if (flags.data) {
667
+ try {
668
+ const content = JSON.parse(flags.data);
669
+ records = Array.isArray(content) ? content : [content];
670
+ }
671
+ catch {
672
+ this.error('Invalid JSON in --data');
673
+ }
674
+ }
675
+ else {
676
+ this.error('Import requires --file or --data holding a JSON array of records');
677
+ }
678
+ if (records.length === 0)
679
+ this.error('Nothing to import: the input is an empty array');
680
+ const params = { format: 'json' };
681
+ if (flags.mode)
682
+ params.mode = flags.mode;
683
+ if (flags.reference)
684
+ params.reference = flags.reference;
685
+ if (flags.async)
686
+ params.async = true;
687
+ const headers = {};
688
+ if (flags['idempotency-key'])
689
+ headers['Idempotency-Key'] = flags['idempotency-key'];
690
+ if (flags['show-http-request']) {
691
+ const baseUrls = getBaseUrls(context.environment);
692
+ const queryString = '?' + Object.entries(params).map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(String(v))}`).join('&');
693
+ process.stderr.write(`\n${endpoint.method.toUpperCase()} ${baseUrls.api}${apiPath}${queryString}\n`);
694
+ process.stderr.write(`Body: [${records.length} record${records.length === 1 ? '' : 's'}]\n\n`);
695
+ }
696
+ try {
697
+ const response = await apiRequest(endpoint.method, apiPath, {
698
+ contextName: flags.context,
699
+ data: records,
700
+ headers,
701
+ params,
702
+ });
703
+ this.printImportRun(response.data, flags);
704
+ }
705
+ catch (error) {
706
+ if (error instanceof ApiError) {
707
+ this.error(`API Error (${error.status}): ${error.message}`);
708
+ }
709
+ throw error;
710
+ }
711
+ }
712
+ /** Renders an import run: its counts, then whatever the server refused. */
713
+ printImportRun(run, flags) {
714
+ if (flags.output === 'json') {
715
+ this.log(JSON.stringify(run, null, 2));
716
+ return;
717
+ }
718
+ const record = (run ?? {});
719
+ const count = (key) => (typeof record[key] === 'number' ? record[key] : 0);
720
+ const id = record.id ? String(record.id) : '';
721
+ this.log(`Import ${id} - ${String(record.status ?? 'UNKNOWN')}${record.async ? ' (background)' : ''}`);
722
+ this.log(` ${count('inputSize')} submitted, ${count('createdCount')} created, ${count('updatedCount')} updated, ${count('unchangedCount')} unchanged`);
723
+ if (count('errorCount') > 0)
724
+ this.log(` ${count('errorCount')} not applied: ${count('refusedCount')} refused, ${count('failedCount')} failed`);
725
+ if (count('warningCount') > 0)
726
+ this.log(` ${count('warningCount')} applied with a warning`);
727
+ // errorLog is keyed by the record's identifier, then by field name.
728
+ const errorLog = record.errorLog;
729
+ if (errorLog && Object.keys(errorLog).length > 0) {
730
+ this.log('');
731
+ for (const [key, fields] of Object.entries(errorLog)) {
732
+ for (const [field, messages] of Object.entries(fields ?? {})) {
733
+ for (const message of messages ?? [])
734
+ this.log(` ${key} ${field}: ${message}`);
735
+ }
736
+ }
737
+ }
738
+ if (record.async && id) {
739
+ this.log('');
740
+ this.log(`Follow it with: aderis imports get ${id}`);
741
+ }
742
+ }
609
743
  async runExport(flags) {
610
744
  const context = flags.context ? getContext(flags.context) : getCurrentContext();
611
745
  if (!context)
@@ -784,9 +918,9 @@ export default class Tenants extends Command {
784
918
  throw error;
785
919
  }
786
920
  }
787
- async runNestedImport(suffix, parentId, flags) {
921
+ async runNestedUpsert(suffix, parentId, flags) {
788
922
  if (!parentId) {
789
- this.error(`Missing required argument: id. Usage: aderis tenants import-${suffix} <parent-id> --file data.json`);
923
+ this.error(`Missing required argument: id. Usage: aderis tenants upsert-${suffix} <parent-id> --file data.json`);
790
924
  }
791
925
  const context = flags.context ? getContext(flags.context) : getCurrentContext();
792
926
  if (!context)
@@ -851,12 +985,12 @@ export default class Tenants extends Command {
851
985
  items = [item];
852
986
  }
853
987
  else {
854
- this.error(`Import requires --file, --data, or --set flags`);
988
+ this.error('Upsert requires --file, --data, or --set flags');
855
989
  }
856
990
  const createEndpoint = ENDPOINTS[`create-${suffix}`];
857
991
  const updateEndpoint = ENDPOINTS[`update-${suffix}`];
858
992
  if (!createEndpoint || !updateEndpoint) {
859
- this.error(`Import requires both create-${suffix} and update-${suffix} endpoints`);
993
+ this.error(`Upsert requires both create-${suffix} and update-${suffix} endpoints`);
860
994
  }
861
995
  // Build the base path with parent ID (first path param)
862
996
  const firstParam = createEndpoint.pathParams[0];
@@ -27,10 +27,19 @@ export default class Tools extends Command {
27
27
  'show-http-request': import("@oclif/core/interfaces").BooleanFlag<boolean>;
28
28
  };
29
29
  run(): Promise<void>;
30
- private runImport;
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 runNestedImport;
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;