@celigo/api-specs 0.2.180 → 0.2.181
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/export.yml +7 -7
- package/dist/import.yml +8 -5
- package/dist/tool.yml +15 -12
- package/package.json +1 -1
- package/schemas.json +2 -2
package/dist/export.yml
CHANGED
|
@@ -9657,7 +9657,7 @@ components:
|
|
|
9657
9657
|
Directory on the server to retrieve files from, either absolute or relative to the login
|
|
9658
9658
|
directory; the FTP user must have read permission on it. Use forward slashes regardless
|
|
9659
9659
|
of server OS — paths are case-sensitive on UNIX/Linux servers. Supports handlebars
|
|
9660
|
-
templates, e.g. archive/{{
|
|
9660
|
+
templates, e.g. archive/{{timestamp 'YYYY-MM-DD'}}.
|
|
9661
9661
|
examples:
|
|
9662
9662
|
- users/dave
|
|
9663
9663
|
- incoming/orders
|
|
@@ -9679,12 +9679,12 @@ components:
|
|
|
9679
9679
|
- Can use static text or handlebars templates
|
|
9680
9680
|
- Examples:
|
|
9681
9681
|
- `"ORDER_"` - matches ORDER_123.csv but not order_123.csv
|
|
9682
|
-
- `"INV_{{
|
|
9682
|
+
- `"INV_{{timestamp 'YYYYMMDD'}}"` - matches current date's invoices
|
|
9683
9683
|
examples:
|
|
9684
9684
|
- ORDER_
|
|
9685
9685
|
- INV_
|
|
9686
9686
|
- EXPORT_
|
|
9687
|
-
- PO_{{
|
|
9687
|
+
- PO_{{timestamp 'YYYYMMDD'}}
|
|
9688
9688
|
fileNameEndsWith:
|
|
9689
9689
|
type: string
|
|
9690
9690
|
x-celigo-agent:
|
|
@@ -9738,7 +9738,7 @@ components:
|
|
|
9738
9738
|
examples:
|
|
9739
9739
|
- processed
|
|
9740
9740
|
- archive
|
|
9741
|
-
- backup/{{
|
|
9741
|
+
- backup/{{timestamp 'YYYY-MM'}}
|
|
9742
9742
|
- /var/ftp/archive
|
|
9743
9743
|
x-celigo-agent:
|
|
9744
9744
|
- handlebars
|
|
@@ -12267,12 +12267,12 @@ components:
|
|
|
12267
12267
|
- Can contain static text or handlebars templates
|
|
12268
12268
|
- Examples:
|
|
12269
12269
|
- `"processed/"` - places files under a processed folder
|
|
12270
|
-
- `"archive/{{
|
|
12270
|
+
- `"archive/{{timestamp 'YYYY-MM-DD'}}/"` - organizes by date
|
|
12271
12271
|
examples:
|
|
12272
12272
|
- processed/
|
|
12273
|
-
- archive/{{
|
|
12273
|
+
- archive/{{timestamp 'YYYY-MM'}}/
|
|
12274
12274
|
- history/
|
|
12275
|
-
- completed/{{
|
|
12275
|
+
- completed/{{timestamp 'YYYY/MM/DD'}}/
|
|
12276
12276
|
x-celigo-agent:
|
|
12277
12277
|
- handlebars
|
|
12278
12278
|
Wrapper:
|
package/dist/import.yml
CHANGED
|
@@ -3091,7 +3091,10 @@ components:
|
|
|
3091
3091
|
description: |-
|
|
3092
3092
|
Name of the file written to the server, including its extension; do not include directory
|
|
3093
3093
|
separators — the location comes from directoryPath. Supports handlebars placeholders such
|
|
3094
|
-
as items-{{timestamp}}.csv to generate a unique name per run
|
|
3094
|
+
as items-{{timestamp}}.csv to generate a unique name per run; `{{timestamp}}` alone renders
|
|
3095
|
+
the full ISO-8601 time, colons included (`2026-10-23T08:25:21.743Z`), and a format gives
|
|
3096
|
+
a date stamp instead: `orders-{{timestamp 'YYYYMMDD'}}.csv`. There is no `date` helper. The
|
|
3097
|
+
template is rendered
|
|
3095
3098
|
against the incoming record: a file-transfer import from an FTP source kept the source
|
|
3096
3099
|
file's name with `{{record.fileMeta.fileName}}` set on `file.fileName` and this field left
|
|
3097
3100
|
unset — other source providers expose the name under their own `fileMeta` field.
|
|
@@ -3163,7 +3166,7 @@ components:
|
|
|
3163
3166
|
- May be influenced by file transfer mode (binary or ASCII) based on the file type.
|
|
3164
3167
|
examples:
|
|
3165
3168
|
- items-{{timestamp}}.csv
|
|
3166
|
-
- orders-{{
|
|
3169
|
+
- orders-{{timestamp 'YYYYMMDD'}}.xml
|
|
3167
3170
|
- export.json
|
|
3168
3171
|
inProgressFileName:
|
|
3169
3172
|
type: string
|
|
@@ -3274,7 +3277,7 @@ components:
|
|
|
3274
3277
|
examples:
|
|
3275
3278
|
- processed
|
|
3276
3279
|
- archive
|
|
3277
|
-
- backup/{{
|
|
3280
|
+
- backup/{{timestamp 'YYYY-MM'}}
|
|
3278
3281
|
Jdbc:
|
|
3279
3282
|
type: object
|
|
3280
3283
|
description: |-
|
|
@@ -8743,13 +8746,13 @@ components:
|
|
|
8743
8746
|
|
|
8744
8747
|
**Common patterns**
|
|
8745
8748
|
- `"data-{{timestamp}}.json"` - Timestamped JSON file (DEFAULT — use this pattern when not specified)
|
|
8746
|
-
- `"export-{{
|
|
8749
|
+
- `"export-{{timestamp 'YYYY-MM-DD'}}.csv"` - Date-stamped CSV file
|
|
8747
8750
|
- `"{{recordType}}-backup.xml"` - Dynamic record type naming
|
|
8748
8751
|
|
|
8749
8752
|
**Examples**
|
|
8750
8753
|
- `"customers-{{timestamp}}.json"`
|
|
8751
8754
|
- `"orders-export.csv"`
|
|
8752
|
-
- `"inventory-{{
|
|
8755
|
+
- `"inventory-{{timestamp 'YYYY-MM-DD'}}.xlsx"`
|
|
8753
8756
|
|
|
8754
8757
|
**Important**
|
|
8755
8758
|
- For S3 imports, this should typically match the `s3.fileKey` value
|
package/dist/tool.yml
CHANGED
|
@@ -14972,7 +14972,10 @@ components:
|
|
|
14972
14972
|
description: |-
|
|
14973
14973
|
Name of the file written to the server, including its extension; do not include directory
|
|
14974
14974
|
separators — the location comes from directoryPath. Supports handlebars placeholders such
|
|
14975
|
-
as items-{{timestamp}}.csv to generate a unique name per run
|
|
14975
|
+
as items-{{timestamp}}.csv to generate a unique name per run; `{{timestamp}}` alone renders
|
|
14976
|
+
the full ISO-8601 time, colons included (`2026-10-23T08:25:21.743Z`), and a format gives
|
|
14977
|
+
a date stamp instead: `orders-{{timestamp 'YYYYMMDD'}}.csv`. There is no `date` helper. The
|
|
14978
|
+
template is rendered
|
|
14976
14979
|
against the incoming record: a file-transfer import from an FTP source kept the source
|
|
14977
14980
|
file's name with `{{record.fileMeta.fileName}}` set on `file.fileName` and this field left
|
|
14978
14981
|
unset — other source providers expose the name under their own `fileMeta` field.
|
|
@@ -15044,7 +15047,7 @@ components:
|
|
|
15044
15047
|
- May be influenced by file transfer mode (binary or ASCII) based on the file type.
|
|
15045
15048
|
examples:
|
|
15046
15049
|
- items-{{timestamp}}.csv
|
|
15047
|
-
- orders-{{
|
|
15050
|
+
- orders-{{timestamp 'YYYYMMDD'}}.xml
|
|
15048
15051
|
- export.json
|
|
15049
15052
|
inProgressFileName:
|
|
15050
15053
|
type: string
|
|
@@ -15155,7 +15158,7 @@ components:
|
|
|
15155
15158
|
examples:
|
|
15156
15159
|
- processed
|
|
15157
15160
|
- archive
|
|
15158
|
-
- backup/{{
|
|
15161
|
+
- backup/{{timestamp 'YYYY-MM'}}
|
|
15159
15162
|
Jdbc:
|
|
15160
15163
|
type: object
|
|
15161
15164
|
description: |-
|
|
@@ -20345,13 +20348,13 @@ components:
|
|
|
20345
20348
|
|
|
20346
20349
|
**Common patterns**
|
|
20347
20350
|
- `"data-{{timestamp}}.json"` - Timestamped JSON file (DEFAULT — use this pattern when not specified)
|
|
20348
|
-
- `"export-{{
|
|
20351
|
+
- `"export-{{timestamp 'YYYY-MM-DD'}}.csv"` - Date-stamped CSV file
|
|
20349
20352
|
- `"{{recordType}}-backup.xml"` - Dynamic record type naming
|
|
20350
20353
|
|
|
20351
20354
|
**Examples**
|
|
20352
20355
|
- `"customers-{{timestamp}}.json"`
|
|
20353
20356
|
- `"orders-export.csv"`
|
|
20354
|
-
- `"inventory-{{
|
|
20357
|
+
- `"inventory-{{timestamp 'YYYY-MM-DD'}}.xlsx"`
|
|
20355
20358
|
|
|
20356
20359
|
**Important**
|
|
20357
20360
|
- For S3 imports, this should typically match the `s3.fileKey` value
|
|
@@ -34702,7 +34705,7 @@ components:
|
|
|
34702
34705
|
Directory on the server to retrieve files from, either absolute or relative to the login
|
|
34703
34706
|
directory; the FTP user must have read permission on it. Use forward slashes regardless
|
|
34704
34707
|
of server OS — paths are case-sensitive on UNIX/Linux servers. Supports handlebars
|
|
34705
|
-
templates, e.g. archive/{{
|
|
34708
|
+
templates, e.g. archive/{{timestamp 'YYYY-MM-DD'}}.
|
|
34706
34709
|
examples:
|
|
34707
34710
|
- users/dave
|
|
34708
34711
|
- incoming/orders
|
|
@@ -34724,12 +34727,12 @@ components:
|
|
|
34724
34727
|
- Can use static text or handlebars templates
|
|
34725
34728
|
- Examples:
|
|
34726
34729
|
- `"ORDER_"` - matches ORDER_123.csv but not order_123.csv
|
|
34727
|
-
- `"INV_{{
|
|
34730
|
+
- `"INV_{{timestamp 'YYYYMMDD'}}"` - matches current date's invoices
|
|
34728
34731
|
examples:
|
|
34729
34732
|
- ORDER_
|
|
34730
34733
|
- INV_
|
|
34731
34734
|
- EXPORT_
|
|
34732
|
-
- PO_{{
|
|
34735
|
+
- PO_{{timestamp 'YYYYMMDD'}}
|
|
34733
34736
|
fileNameEndsWith:
|
|
34734
34737
|
type: string
|
|
34735
34738
|
x-celigo-agent:
|
|
@@ -34783,7 +34786,7 @@ components:
|
|
|
34783
34786
|
examples:
|
|
34784
34787
|
- processed
|
|
34785
34788
|
- archive
|
|
34786
|
-
- backup/{{
|
|
34789
|
+
- backup/{{timestamp 'YYYY-MM'}}
|
|
34787
34790
|
- /var/ftp/archive
|
|
34788
34791
|
x-celigo-agent:
|
|
34789
34792
|
- handlebars
|
|
@@ -37312,12 +37315,12 @@ components:
|
|
|
37312
37315
|
- Can contain static text or handlebars templates
|
|
37313
37316
|
- Examples:
|
|
37314
37317
|
- `"processed/"` - places files under a processed folder
|
|
37315
|
-
- `"archive/{{
|
|
37318
|
+
- `"archive/{{timestamp 'YYYY-MM-DD'}}/"` - organizes by date
|
|
37316
37319
|
examples:
|
|
37317
37320
|
- processed/
|
|
37318
|
-
- archive/{{
|
|
37321
|
+
- archive/{{timestamp 'YYYY-MM'}}/
|
|
37319
37322
|
- history/
|
|
37320
|
-
- completed/{{
|
|
37323
|
+
- completed/{{timestamp 'YYYY/MM/DD'}}/
|
|
37321
37324
|
x-celigo-agent:
|
|
37322
37325
|
- handlebars
|
|
37323
37326
|
Wrapper-3:
|
package/package.json
CHANGED