@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,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 = ["ledger-mappings"];
9
- const SUBCOMMANDS = [...["list", "create", "get", "update", "delete", "list-ledger-mappings", "create-ledger-mappings", "get-ledger-mappings", "update-ledger-mappings", "delete-ledger-mappings"], ...(HAS_IMPORT ? ['import'] : []), ...(HAS_EXPORT ? ['export'] : []), ...NESTED_IMPORTS.map(n => `import-${n}`)];
10
+ const SERVER_IMPORTS = [];
11
+ const NESTED_UPSERTS = ["ledger-mappings"];
12
+ const SUBCOMMANDS = [...["list", "create", "get", "update", "delete", "list-ledger-mappings", "create-ledger-mappings", "get-ledger-mappings", "update-ledger-mappings", "delete-ledger-mappings"], ...(HAS_UPSERT ? ['upsert'] : []), ...(HAS_EXPORT ? ['export'] : []), ...NESTED_UPSERTS.map(n => `upsert-${n}`)];
10
13
  const ENDPOINTS = {
11
14
  'list': { method: 'GET', path: '/v1/payment-methods', summary: 'Get all payment methods with pagination', pathParams: [], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
12
15
  'create': { method: 'POST', path: '/v1/payment-methods', summary: 'Create a new payment method', pathParams: [], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: ['alternativeBankAccountIds', 'alternativeCreditCardAccountIds'] },
@@ -26,7 +29,7 @@ export default class PaymentMethods extends Command {
26
29
  '<%= config.bin %> payment-methods get <id>',
27
30
  '<%= config.bin %> payment-methods create --data \'{...}\'',
28
31
  '<%= config.bin %> payment-methods update <id> --set field=value',
29
- '<%= config.bin %> payment-methods import --file data.json',
32
+ '<%= config.bin %> payment-methods upsert --file data.json',
30
33
  '<%= config.bin %> payment-methods export --csv > payment-methods.csv',
31
34
  ];
32
35
  static args = {
@@ -35,7 +38,7 @@ export default class PaymentMethods extends Command {
35
38
  };
36
39
  static flags = {
37
40
  context: Flags.string({ char: 'c', aliases: ['config'], env: 'ADERIS_CONTEXT', description: 'Context to use for this command, overriding the current context (alias: --config)' }),
38
- output: Flags.string({ char: 'o', description: 'Output format (default: table for import, json for other commands)', options: ['json', 'table', 'csv'] }),
41
+ output: Flags.string({ char: 'o', description: 'Output format (default: table for upsert, json for other commands)', options: ['json', 'table', 'csv'] }),
39
42
  table: Flags.boolean({ char: 't', description: 'Output as table (shortcut for --output table)' }),
40
43
  csv: Flags.boolean({ description: 'Output as CSV (shortcut for --output csv)' }),
41
44
  data: Flags.string({ char: 'd', description: 'JSON data for request body' }),
@@ -56,11 +59,26 @@ export default class PaymentMethods extends Command {
56
59
  };
57
60
  async run() {
58
61
  const { args, flags } = await this.parse(PaymentMethods);
59
- // Handle import action specially
60
- if (args.action === 'import') {
61
- if (!HAS_IMPORT)
62
- this.error('Import not available for this resource');
63
- await this.runImport(flags);
62
+ // Bulk actions. 'import' is the API's own endpoint: one request, answered
63
+ // by a run that records what happened to every record. 'upsert' is the CLI
64
+ // looping create/update. A resource has one or the other, never both.
65
+ if (args.action === 'upsert') {
66
+ if (!HAS_UPSERT) {
67
+ this.error(SERVER_IMPORTS.includes('import')
68
+ ? 'This resource is imported by the API. Use: aderis payment-methods import --file data.json'
69
+ : 'Upsert needs both a create and an update endpoint, which this resource does not have');
70
+ }
71
+ await this.runUpsert(flags);
72
+ return;
73
+ }
74
+ if (args.action.startsWith('upsert-')) {
75
+ const suffix = args.action.replace('upsert-', '');
76
+ if (!NESTED_UPSERTS.includes(suffix)) {
77
+ this.error(SERVER_IMPORTS.includes('import-' + suffix)
78
+ ? `That resource is imported by the API. Use: aderis payment-methods import-${suffix} <id> --file data.json`
79
+ : `Unknown action: ${args.action}. Available: ${SUBCOMMANDS.join(', ')}`);
80
+ }
81
+ await this.runNestedUpsert(suffix, args.id, flags);
64
82
  return;
65
83
  }
66
84
  // Handle export action specially
@@ -77,12 +95,17 @@ export default class PaymentMethods extends Command {
77
95
  await this.runCamt053Import(flags);
78
96
  return;
79
97
  }
80
- // Handle nested resource imports (e.g., import-prices)
81
- if (args.action.startsWith('import-')) {
82
- const suffix = args.action.replace('import-', '');
83
- if (NESTED_IMPORTS.includes(suffix)) {
84
- await this.runNestedImport(suffix, args.id, flags);
85
- return;
98
+ if (SERVER_IMPORTS.includes(args.action)) {
99
+ await this.runServerImport(args.action, args.id, flags);
100
+ return;
101
+ }
102
+ // 'import' used to name the CLI's create/update loop on every resource. It
103
+ // now names the API endpoint, which most resources do not have.
104
+ if (args.action === 'import' || args.action.startsWith('import-')) {
105
+ const suffix = args.action === 'import' ? '' : '-' + args.action.replace('import-', '');
106
+ const loops = args.action === 'import' ? HAS_UPSERT : NESTED_UPSERTS.includes(args.action.replace('import-', ''));
107
+ if (loops) {
108
+ this.error(`This resource has no import endpoint. Use: aderis payment-methods upsert${suffix}${suffix ? ' <id>' : ''} --file data.json`);
86
109
  }
87
110
  }
88
111
  const endpoint = ENDPOINTS[args.action];
@@ -397,7 +420,7 @@ export default class PaymentMethods extends Command {
397
420
  throw error;
398
421
  }
399
422
  }
400
- async runImport(flags) {
423
+ async runUpsert(flags) {
401
424
  const context = flags.context ? getContext(flags.context) : getCurrentContext();
402
425
  if (!context)
403
426
  this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
@@ -461,12 +484,12 @@ export default class PaymentMethods extends Command {
461
484
  items = [item];
462
485
  }
463
486
  else {
464
- this.error('Import requires --file, --data, or --set flags');
487
+ this.error('Upsert requires --file, --data, or --set flags');
465
488
  }
466
489
  const createEndpoint = ENDPOINTS['create'];
467
490
  const updateEndpoint = ENDPOINTS['update'];
468
491
  if (!createEndpoint || !updateEndpoint) {
469
- this.error('Import requires both create and update endpoints');
492
+ this.error('Upsert requires both create and update endpoints');
470
493
  }
471
494
  // Helper to extract identifier from item (id, code, or xxxCode)
472
495
  const getItemIdentifier = (item) => {
@@ -609,6 +632,117 @@ export default class PaymentMethods extends Command {
609
632
  this.log('');
610
633
  this.log(`Summary: ${created} created, ${updated} updated, ${errors.length} failed`);
611
634
  }
635
+ /**
636
+ * The API's own import: the whole array goes up in one request and comes
637
+ * back as an import run, which records what happened to every record. A bad
638
+ * record lands in errorLog and the rest are still applied, and the run stays
639
+ * readable afterwards with: aderis imports get <id>.
640
+ */
641
+ async runServerImport(action, parentId, flags) {
642
+ const endpoint = ENDPOINTS[action];
643
+ if (!endpoint)
644
+ this.error(`Unknown action: ${action}. Available: ${SUBCOMMANDS.join(', ')}`);
645
+ const context = flags.context ? getContext(flags.context) : getCurrentContext();
646
+ if (!context)
647
+ this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
648
+ if (!hasCredentials(context))
649
+ this.error(missingCredentialsMessage(context));
650
+ let apiPath = endpoint.path;
651
+ if (endpoint.pathParams.length > 0) {
652
+ if (!parentId)
653
+ this.error(`Missing required argument: id. Usage: aderis payment-methods ${action} <parent-id> --file data.json`);
654
+ apiPath = apiPath.replace(`{${endpoint.pathParams[0]}}`, parentId);
655
+ }
656
+ // The endpoint takes an array. A single object is wrapped, so importing
657
+ // one record reads the same as importing many.
658
+ let records = [];
659
+ if (flags.file) {
660
+ const fsModule = await import('node:fs');
661
+ try {
662
+ const content = JSON.parse(fsModule.readFileSync(flags.file, 'utf-8'));
663
+ records = Array.isArray(content) ? content : [content];
664
+ }
665
+ catch {
666
+ this.error(`Failed to read file: ${flags.file}`);
667
+ }
668
+ }
669
+ else if (flags.data) {
670
+ try {
671
+ const content = JSON.parse(flags.data);
672
+ records = Array.isArray(content) ? content : [content];
673
+ }
674
+ catch {
675
+ this.error('Invalid JSON in --data');
676
+ }
677
+ }
678
+ else {
679
+ this.error('Import requires --file or --data holding a JSON array of records');
680
+ }
681
+ if (records.length === 0)
682
+ this.error('Nothing to import: the input is an empty array');
683
+ const params = { format: 'json' };
684
+ if (flags.mode)
685
+ params.mode = flags.mode;
686
+ if (flags.reference)
687
+ params.reference = flags.reference;
688
+ if (flags.async)
689
+ params.async = true;
690
+ const headers = {};
691
+ if (flags['idempotency-key'])
692
+ headers['Idempotency-Key'] = flags['idempotency-key'];
693
+ if (flags['show-http-request']) {
694
+ const baseUrls = getBaseUrls(context.environment);
695
+ const queryString = '?' + Object.entries(params).map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(String(v))}`).join('&');
696
+ process.stderr.write(`\n${endpoint.method.toUpperCase()} ${baseUrls.api}${apiPath}${queryString}\n`);
697
+ process.stderr.write(`Body: [${records.length} record${records.length === 1 ? '' : 's'}]\n\n`);
698
+ }
699
+ try {
700
+ const response = await apiRequest(endpoint.method, apiPath, {
701
+ contextName: flags.context,
702
+ data: records,
703
+ headers,
704
+ params,
705
+ });
706
+ this.printImportRun(response.data, flags);
707
+ }
708
+ catch (error) {
709
+ if (error instanceof ApiError) {
710
+ this.error(`API Error (${error.status}): ${error.message}`);
711
+ }
712
+ throw error;
713
+ }
714
+ }
715
+ /** Renders an import run: its counts, then whatever the server refused. */
716
+ printImportRun(run, flags) {
717
+ if (flags.output === 'json') {
718
+ this.log(JSON.stringify(run, null, 2));
719
+ return;
720
+ }
721
+ const record = (run ?? {});
722
+ const count = (key) => (typeof record[key] === 'number' ? record[key] : 0);
723
+ const id = record.id ? String(record.id) : '';
724
+ this.log(`Import ${id} - ${String(record.status ?? 'UNKNOWN')}${record.async ? ' (background)' : ''}`);
725
+ this.log(` ${count('inputSize')} submitted, ${count('createdCount')} created, ${count('updatedCount')} updated, ${count('unchangedCount')} unchanged`);
726
+ if (count('errorCount') > 0)
727
+ this.log(` ${count('errorCount')} not applied: ${count('refusedCount')} refused, ${count('failedCount')} failed`);
728
+ if (count('warningCount') > 0)
729
+ this.log(` ${count('warningCount')} applied with a warning`);
730
+ // errorLog is keyed by the record's identifier, then by field name.
731
+ const errorLog = record.errorLog;
732
+ if (errorLog && Object.keys(errorLog).length > 0) {
733
+ this.log('');
734
+ for (const [key, fields] of Object.entries(errorLog)) {
735
+ for (const [field, messages] of Object.entries(fields ?? {})) {
736
+ for (const message of messages ?? [])
737
+ this.log(` ${key} ${field}: ${message}`);
738
+ }
739
+ }
740
+ }
741
+ if (record.async && id) {
742
+ this.log('');
743
+ this.log(`Follow it with: aderis imports get ${id}`);
744
+ }
745
+ }
612
746
  async runExport(flags) {
613
747
  const context = flags.context ? getContext(flags.context) : getCurrentContext();
614
748
  if (!context)
@@ -787,9 +921,9 @@ export default class PaymentMethods extends Command {
787
921
  throw error;
788
922
  }
789
923
  }
790
- async runNestedImport(suffix, parentId, flags) {
924
+ async runNestedUpsert(suffix, parentId, flags) {
791
925
  if (!parentId) {
792
- this.error(`Missing required argument: id. Usage: aderis payment-methods import-${suffix} <parent-id> --file data.json`);
926
+ this.error(`Missing required argument: id. Usage: aderis payment-methods upsert-${suffix} <parent-id> --file data.json`);
793
927
  }
794
928
  const context = flags.context ? getContext(flags.context) : getCurrentContext();
795
929
  if (!context)
@@ -854,12 +988,12 @@ export default class PaymentMethods extends Command {
854
988
  items = [item];
855
989
  }
856
990
  else {
857
- this.error(`Import requires --file, --data, or --set flags`);
991
+ this.error('Upsert requires --file, --data, or --set flags');
858
992
  }
859
993
  const createEndpoint = ENDPOINTS[`create-${suffix}`];
860
994
  const updateEndpoint = ENDPOINTS[`update-${suffix}`];
861
995
  if (!createEndpoint || !updateEndpoint) {
862
- this.error(`Import requires both create-${suffix} and update-${suffix} endpoints`);
996
+ this.error(`Upsert requires both create-${suffix} and update-${suffix} endpoints`);
863
997
  }
864
998
  // Build the base path with parent ID (first path param)
865
999
  const firstParam = createEndpoint.pathParams[0];
@@ -29,10 +29,19 @@ export default class PaymentRuns extends Command {
29
29
  'show-http-request': import("@oclif/core/interfaces").BooleanFlag<boolean>;
30
30
  };
31
31
  run(): Promise<void>;
32
- private runImport;
32
+ private runUpsert;
33
+ /**
34
+ * The API's own import: the whole array goes up in one request and comes
35
+ * back as an import run, which records what happened to every record. A bad
36
+ * record lands in errorLog and the rest are still applied, and the run stays
37
+ * readable afterwards with: aderis imports get <id>.
38
+ */
39
+ private runServerImport;
40
+ /** Renders an import run: its counts, then whatever the server refused. */
41
+ private printImportRun;
33
42
  private runExport;
34
43
  private runCamt053Import;
35
- private runNestedImport;
44
+ private runNestedUpsert;
36
45
  private parseFilterValue;
37
46
  /** The page line under a table: which page, how many, and any sums the API returned. */
38
47
  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 = [...["open-submissions", "eligible-payments", "list", "create", "preview", "schedule", "status", "get", "update", "delete", "create-payments", "delete-payments", "send", "painfile", "beneficiary-check", "sync-status", "sync-status-xml", "sync-all"], ...(HAS_IMPORT ? ['import'] : []), ...(HAS_EXPORT ? ['export'] : []), ...NESTED_IMPORTS.map(n => `import-${n}`)];
10
+ const SERVER_IMPORTS = [];
11
+ const NESTED_UPSERTS = [];
12
+ const SUBCOMMANDS = [...["open-submissions", "eligible-payments", "list", "create", "preview", "schedule", "status", "get", "update", "delete", "create-payments", "delete-payments", "send", "painfile", "beneficiary-check", "sync-status", "sync-status-xml", "sync-all"], ...(HAS_UPSERT ? ['upsert'] : []), ...(HAS_EXPORT ? ['export'] : []), ...NESTED_UPSERTS.map(n => `upsert-${n}`)];
10
13
  const ENDPOINTS = {
11
14
  'open-submissions': { method: 'GET', path: '/v1/payment-runs/bank-accounts/{bankAccountId}/open-submissions', summary: 'Get open submission IDs for a bank account', pathParams: ['bankAccountId'], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
12
15
  'eligible-payments': { method: 'GET', path: '/v1/payment-runs/eligible-payments/{bankAccountId}', summary: 'Show what a payment run from this bank account would pay', pathParams: ['bankAccountId'], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
@@ -34,7 +37,7 @@ export default class PaymentRuns extends Command {
34
37
  '<%= config.bin %> payment-runs get <id>',
35
38
  '<%= config.bin %> payment-runs create --data \'{...}\'',
36
39
  '<%= config.bin %> payment-runs update <id> --set field=value',
37
- '<%= config.bin %> payment-runs import --file data.json',
40
+ '<%= config.bin %> payment-runs upsert --file data.json',
38
41
  '<%= config.bin %> payment-runs export --csv > payment-runs.csv',
39
42
  ];
40
43
  static args = {
@@ -43,7 +46,7 @@ export default class PaymentRuns extends Command {
43
46
  };
44
47
  static flags = {
45
48
  context: Flags.string({ char: 'c', aliases: ['config'], env: 'ADERIS_CONTEXT', description: 'Context to use for this command, overriding the current context (alias: --config)' }),
46
- output: Flags.string({ char: 'o', description: 'Output format (default: table for import, json for other commands)', options: ['json', 'table', 'csv'] }),
49
+ output: Flags.string({ char: 'o', description: 'Output format (default: table for upsert, json for other commands)', options: ['json', 'table', 'csv'] }),
47
50
  table: Flags.boolean({ char: 't', description: 'Output as table (shortcut for --output table)' }),
48
51
  csv: Flags.boolean({ description: 'Output as CSV (shortcut for --output csv)' }),
49
52
  data: Flags.string({ char: 'd', description: 'JSON data for request body' }),
@@ -65,11 +68,26 @@ export default class PaymentRuns extends Command {
65
68
  };
66
69
  async run() {
67
70
  const { args, flags } = await this.parse(PaymentRuns);
68
- // Handle import action specially
69
- if (args.action === 'import') {
70
- if (!HAS_IMPORT)
71
- this.error('Import not available for this resource');
72
- await this.runImport(flags);
71
+ // Bulk actions. 'import' is the API's own endpoint: one request, answered
72
+ // by a run that records what happened to every record. 'upsert' is the CLI
73
+ // looping create/update. A resource has one or the other, never both.
74
+ if (args.action === 'upsert') {
75
+ if (!HAS_UPSERT) {
76
+ this.error(SERVER_IMPORTS.includes('import')
77
+ ? 'This resource is imported by the API. Use: aderis payment-runs import --file data.json'
78
+ : 'Upsert needs both a create and an update endpoint, which this resource does not have');
79
+ }
80
+ await this.runUpsert(flags);
81
+ return;
82
+ }
83
+ if (args.action.startsWith('upsert-')) {
84
+ const suffix = args.action.replace('upsert-', '');
85
+ if (!NESTED_UPSERTS.includes(suffix)) {
86
+ this.error(SERVER_IMPORTS.includes('import-' + suffix)
87
+ ? `That resource is imported by the API. Use: aderis payment-runs import-${suffix} <id> --file data.json`
88
+ : `Unknown action: ${args.action}. Available: ${SUBCOMMANDS.join(', ')}`);
89
+ }
90
+ await this.runNestedUpsert(suffix, args.id, flags);
73
91
  return;
74
92
  }
75
93
  // Handle export action specially
@@ -86,12 +104,17 @@ export default class PaymentRuns extends Command {
86
104
  await this.runCamt053Import(flags);
87
105
  return;
88
106
  }
89
- // Handle nested resource imports (e.g., import-prices)
90
- if (args.action.startsWith('import-')) {
91
- const suffix = args.action.replace('import-', '');
92
- if (NESTED_IMPORTS.includes(suffix)) {
93
- await this.runNestedImport(suffix, args.id, flags);
94
- return;
107
+ if (SERVER_IMPORTS.includes(args.action)) {
108
+ await this.runServerImport(args.action, args.id, flags);
109
+ return;
110
+ }
111
+ // 'import' used to name the CLI's create/update loop on every resource. It
112
+ // now names the API endpoint, which most resources do not have.
113
+ if (args.action === 'import' || args.action.startsWith('import-')) {
114
+ const suffix = args.action === 'import' ? '' : '-' + args.action.replace('import-', '');
115
+ const loops = args.action === 'import' ? HAS_UPSERT : NESTED_UPSERTS.includes(args.action.replace('import-', ''));
116
+ if (loops) {
117
+ this.error(`This resource has no import endpoint. Use: aderis payment-runs upsert${suffix}${suffix ? ' <id>' : ''} --file data.json`);
95
118
  }
96
119
  }
97
120
  const endpoint = ENDPOINTS[args.action];
@@ -406,7 +429,7 @@ export default class PaymentRuns extends Command {
406
429
  throw error;
407
430
  }
408
431
  }
409
- async runImport(flags) {
432
+ async runUpsert(flags) {
410
433
  const context = flags.context ? getContext(flags.context) : getCurrentContext();
411
434
  if (!context)
412
435
  this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
@@ -470,12 +493,12 @@ export default class PaymentRuns extends Command {
470
493
  items = [item];
471
494
  }
472
495
  else {
473
- this.error('Import requires --file, --data, or --set flags');
496
+ this.error('Upsert requires --file, --data, or --set flags');
474
497
  }
475
498
  const createEndpoint = ENDPOINTS['create'];
476
499
  const updateEndpoint = ENDPOINTS['update'];
477
500
  if (!createEndpoint || !updateEndpoint) {
478
- this.error('Import requires both create and update endpoints');
501
+ this.error('Upsert requires both create and update endpoints');
479
502
  }
480
503
  // Helper to extract identifier from item (id, code, or xxxCode)
481
504
  const getItemIdentifier = (item) => {
@@ -618,6 +641,117 @@ export default class PaymentRuns extends Command {
618
641
  this.log('');
619
642
  this.log(`Summary: ${created} created, ${updated} updated, ${errors.length} failed`);
620
643
  }
644
+ /**
645
+ * The API's own import: the whole array goes up in one request and comes
646
+ * back as an import run, which records what happened to every record. A bad
647
+ * record lands in errorLog and the rest are still applied, and the run stays
648
+ * readable afterwards with: aderis imports get <id>.
649
+ */
650
+ async runServerImport(action, parentId, flags) {
651
+ const endpoint = ENDPOINTS[action];
652
+ if (!endpoint)
653
+ this.error(`Unknown action: ${action}. Available: ${SUBCOMMANDS.join(', ')}`);
654
+ const context = flags.context ? getContext(flags.context) : getCurrentContext();
655
+ if (!context)
656
+ this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
657
+ if (!hasCredentials(context))
658
+ this.error(missingCredentialsMessage(context));
659
+ let apiPath = endpoint.path;
660
+ if (endpoint.pathParams.length > 0) {
661
+ if (!parentId)
662
+ this.error(`Missing required argument: id. Usage: aderis payment-runs ${action} <parent-id> --file data.json`);
663
+ apiPath = apiPath.replace(`{${endpoint.pathParams[0]}}`, parentId);
664
+ }
665
+ // The endpoint takes an array. A single object is wrapped, so importing
666
+ // one record reads the same as importing many.
667
+ let records = [];
668
+ if (flags.file) {
669
+ const fsModule = await import('node:fs');
670
+ try {
671
+ const content = JSON.parse(fsModule.readFileSync(flags.file, 'utf-8'));
672
+ records = Array.isArray(content) ? content : [content];
673
+ }
674
+ catch {
675
+ this.error(`Failed to read file: ${flags.file}`);
676
+ }
677
+ }
678
+ else if (flags.data) {
679
+ try {
680
+ const content = JSON.parse(flags.data);
681
+ records = Array.isArray(content) ? content : [content];
682
+ }
683
+ catch {
684
+ this.error('Invalid JSON in --data');
685
+ }
686
+ }
687
+ else {
688
+ this.error('Import requires --file or --data holding a JSON array of records');
689
+ }
690
+ if (records.length === 0)
691
+ this.error('Nothing to import: the input is an empty array');
692
+ const params = { format: 'json' };
693
+ if (flags.mode)
694
+ params.mode = flags.mode;
695
+ if (flags.reference)
696
+ params.reference = flags.reference;
697
+ if (flags.async)
698
+ params.async = true;
699
+ const headers = {};
700
+ if (flags['idempotency-key'])
701
+ headers['Idempotency-Key'] = flags['idempotency-key'];
702
+ if (flags['show-http-request']) {
703
+ const baseUrls = getBaseUrls(context.environment);
704
+ const queryString = '?' + Object.entries(params).map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(String(v))}`).join('&');
705
+ process.stderr.write(`\n${endpoint.method.toUpperCase()} ${baseUrls.api}${apiPath}${queryString}\n`);
706
+ process.stderr.write(`Body: [${records.length} record${records.length === 1 ? '' : 's'}]\n\n`);
707
+ }
708
+ try {
709
+ const response = await apiRequest(endpoint.method, apiPath, {
710
+ contextName: flags.context,
711
+ data: records,
712
+ headers,
713
+ params,
714
+ });
715
+ this.printImportRun(response.data, flags);
716
+ }
717
+ catch (error) {
718
+ if (error instanceof ApiError) {
719
+ this.error(`API Error (${error.status}): ${error.message}`);
720
+ }
721
+ throw error;
722
+ }
723
+ }
724
+ /** Renders an import run: its counts, then whatever the server refused. */
725
+ printImportRun(run, flags) {
726
+ if (flags.output === 'json') {
727
+ this.log(JSON.stringify(run, null, 2));
728
+ return;
729
+ }
730
+ const record = (run ?? {});
731
+ const count = (key) => (typeof record[key] === 'number' ? record[key] : 0);
732
+ const id = record.id ? String(record.id) : '';
733
+ this.log(`Import ${id} - ${String(record.status ?? 'UNKNOWN')}${record.async ? ' (background)' : ''}`);
734
+ this.log(` ${count('inputSize')} submitted, ${count('createdCount')} created, ${count('updatedCount')} updated, ${count('unchangedCount')} unchanged`);
735
+ if (count('errorCount') > 0)
736
+ this.log(` ${count('errorCount')} not applied: ${count('refusedCount')} refused, ${count('failedCount')} failed`);
737
+ if (count('warningCount') > 0)
738
+ this.log(` ${count('warningCount')} applied with a warning`);
739
+ // errorLog is keyed by the record's identifier, then by field name.
740
+ const errorLog = record.errorLog;
741
+ if (errorLog && Object.keys(errorLog).length > 0) {
742
+ this.log('');
743
+ for (const [key, fields] of Object.entries(errorLog)) {
744
+ for (const [field, messages] of Object.entries(fields ?? {})) {
745
+ for (const message of messages ?? [])
746
+ this.log(` ${key} ${field}: ${message}`);
747
+ }
748
+ }
749
+ }
750
+ if (record.async && id) {
751
+ this.log('');
752
+ this.log(`Follow it with: aderis imports get ${id}`);
753
+ }
754
+ }
621
755
  async runExport(flags) {
622
756
  const context = flags.context ? getContext(flags.context) : getCurrentContext();
623
757
  if (!context)
@@ -796,9 +930,9 @@ export default class PaymentRuns extends Command {
796
930
  throw error;
797
931
  }
798
932
  }
799
- async runNestedImport(suffix, parentId, flags) {
933
+ async runNestedUpsert(suffix, parentId, flags) {
800
934
  if (!parentId) {
801
- this.error(`Missing required argument: id. Usage: aderis payment-runs import-${suffix} <parent-id> --file data.json`);
935
+ this.error(`Missing required argument: id. Usage: aderis payment-runs upsert-${suffix} <parent-id> --file data.json`);
802
936
  }
803
937
  const context = flags.context ? getContext(flags.context) : getCurrentContext();
804
938
  if (!context)
@@ -863,12 +997,12 @@ export default class PaymentRuns extends Command {
863
997
  items = [item];
864
998
  }
865
999
  else {
866
- this.error(`Import requires --file, --data, or --set flags`);
1000
+ this.error('Upsert requires --file, --data, or --set flags');
867
1001
  }
868
1002
  const createEndpoint = ENDPOINTS[`create-${suffix}`];
869
1003
  const updateEndpoint = ENDPOINTS[`update-${suffix}`];
870
1004
  if (!createEndpoint || !updateEndpoint) {
871
- this.error(`Import requires both create-${suffix} and update-${suffix} endpoints`);
1005
+ this.error(`Upsert requires both create-${suffix} and update-${suffix} endpoints`);
872
1006
  }
873
1007
  // Build the base path with parent ID (first path param)
874
1008
  const firstParam = createEndpoint.pathParams[0];
@@ -27,10 +27,19 @@ export default class PaymentTerms 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;