@celigo/api-specs 0.2.200 → 0.2.202
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/alert.yml +36 -7
- package/dist/api.yml +47 -5
- package/dist/audit.yml +26 -25
- package/dist/connection.yml +16 -0
- package/dist/enduser.yml +16 -0
- package/dist/filedefinition.yml +26 -17
- package/dist/filestorage.yml +73 -19
- package/dist/flow.yml +10 -4
- package/dist/integration.yml +50 -18
- package/dist/marketplace.yml +10 -0
- package/dist/mcp-server.yml +458 -0
- package/dist/template.yml +122 -11
- package/dist/tool.yml +22 -1
- package/package.json +1 -1
- package/schemas.json +3 -1
package/dist/alert.yml
CHANGED
|
@@ -513,6 +513,10 @@ paths:
|
|
|
513
513
|
|
|
514
514
|
Requires permission to read the alert (`get:alert:model`). Returns `403`
|
|
515
515
|
when `ENABLE_PROACTIVE_ALERTS` is off or the caller lacks access.
|
|
516
|
+
|
|
517
|
+
The history stays readable after the alert is deleted, even though the alert
|
|
518
|
+
itself then reads 404. The same entries also appear in the integration's audit
|
|
519
|
+
log (`GET /v1/integrations/{_id}/audit`).
|
|
516
520
|
parameters:
|
|
517
521
|
- name: _id
|
|
518
522
|
in: path
|
|
@@ -604,6 +608,14 @@ paths:
|
|
|
604
608
|
description: Alert id.
|
|
605
609
|
examples:
|
|
606
610
|
- 674a1b2c3d4e5f6789012345
|
|
611
|
+
resourceName:
|
|
612
|
+
type: string
|
|
613
|
+
description: |-
|
|
614
|
+
Display name of the alert: `<type label> - <flow name>` for a flow-level
|
|
615
|
+
alert, `<type label> - All flows (<integration name>)` for an
|
|
616
|
+
integration-level alert.
|
|
617
|
+
examples:
|
|
618
|
+
- Long runtime - All flows (Shopify to NetSuite)
|
|
607
619
|
event:
|
|
608
620
|
type: string
|
|
609
621
|
description: Mutation event type.
|
|
@@ -664,26 +676,41 @@ paths:
|
|
|
664
676
|
properties:
|
|
665
677
|
fieldPath:
|
|
666
678
|
type: string
|
|
667
|
-
description:
|
|
679
|
+
description: |-
|
|
680
|
+
Dot-notation path of the changed field. A recipient change is reported
|
|
681
|
+
as `recipients`, listing the recipients' email addresses instead of user
|
|
682
|
+
ids.
|
|
668
683
|
examples:
|
|
669
|
-
- longRuntime
|
|
684
|
+
- longRuntime
|
|
670
685
|
oldValue:
|
|
671
686
|
description: Previous value (absent on create).
|
|
672
687
|
newValue:
|
|
673
688
|
description: New value (absent on delete).
|
|
674
689
|
deletedInfo:
|
|
675
690
|
type: object
|
|
676
|
-
description:
|
|
691
|
+
description: |-
|
|
692
|
+
Metadata about the deleted alert. Once the alert is deleted, every entry in its
|
|
693
|
+
history carries it, not only the `delete` entry.
|
|
677
694
|
properties:
|
|
678
695
|
name:
|
|
679
696
|
type: string
|
|
680
|
-
description:
|
|
697
|
+
description: Display name of the alert at the time of deletion.
|
|
698
|
+
examples:
|
|
699
|
+
- Long runtime - All flows (Shopify to NetSuite)
|
|
700
|
+
_integrationId:
|
|
701
|
+
type: string
|
|
702
|
+
format: objectId
|
|
703
|
+
x-celigo-refModel: integrations
|
|
704
|
+
description: Integration the alert belonged to.
|
|
705
|
+
examples:
|
|
706
|
+
- 5e5eb06fdd83ed4f8206a4ea
|
|
681
707
|
examples:
|
|
682
708
|
default:
|
|
683
709
|
value:
|
|
684
710
|
- _id: 69e38cb1a749d34a9732a270
|
|
685
711
|
resourceType: alert
|
|
686
712
|
_resourceId: 674a1b2c3d4e5f6789012345
|
|
713
|
+
resourceName: Long runtime - All flows (Shopify to NetSuite)
|
|
687
714
|
source: api
|
|
688
715
|
event: update
|
|
689
716
|
time: '2026-04-18T13:52:49.729Z'
|
|
@@ -692,9 +719,11 @@ paths:
|
|
|
692
719
|
email: user@example.com
|
|
693
720
|
name: Jane Doe
|
|
694
721
|
fieldChanges:
|
|
695
|
-
- fieldPath: longRuntime
|
|
696
|
-
oldValue:
|
|
697
|
-
|
|
722
|
+
- fieldPath: longRuntime
|
|
723
|
+
oldValue:
|
|
724
|
+
thresholdMinutes: 30
|
|
725
|
+
newValue:
|
|
726
|
+
thresholdMinutes: 45
|
|
698
727
|
'204':
|
|
699
728
|
description: No audit entries exist for this alert.
|
|
700
729
|
'400':
|
package/dist/api.yml
CHANGED
|
@@ -519,6 +519,7 @@ paths:
|
|
|
519
519
|
| `/logging/mode` | Logging level for requests handled by this API |
|
|
520
520
|
| `/logging/debugUntil` | End of a temporary full-debug capture window |
|
|
521
521
|
| `/traceKeyTemplate` | Handlebars template that computes each request's trace key |
|
|
522
|
+
| `/failOnOfflineConnection` | Turn the offline-connection check on or off (boolean) |
|
|
522
523
|
|
|
523
524
|
All other paths are rejected with `422`. This is the only way to change
|
|
524
525
|
`logging` -- PUT silently ignores that field.
|
|
@@ -5748,6 +5749,12 @@ components:
|
|
|
5748
5749
|
step's response is discarded after the call.
|
|
5749
5750
|
|
|
5750
5751
|
`fields` and `lists` are plain arrays — exactly the shape GET returns.
|
|
5752
|
+
Entries sent empty (`null`, `{}`, or every value `null`) are dropped on
|
|
5753
|
+
save. Any other `fields` entry left with neither `extract` nor
|
|
5754
|
+
`generate`, or `lists` entry with neither `generate` nor `fields` —
|
|
5755
|
+
what is left of a wrapped or misspelled value such as
|
|
5756
|
+
`"fields": {"type": [...]}` — fails the save with 422
|
|
5757
|
+
`invalid_field_value`.
|
|
5751
5758
|
|
|
5752
5759
|
Extract paths do NOT read the raw application response — the platform
|
|
5753
5760
|
wraps every response in a canonical per-record envelope first, and
|
|
@@ -5804,10 +5811,10 @@ components:
|
|
|
5804
5811
|
runs on top of it in a test run).
|
|
5805
5812
|
- |-
|
|
5806
5813
|
Send `fields` and `lists` as bare arrays, exactly as GET returns them.
|
|
5807
|
-
|
|
5808
|
-
|
|
5809
|
-
|
|
5810
|
-
|
|
5814
|
+
A wrapped value (e.g. `"fields": {"type": [...]}`), an empty object
|
|
5815
|
+
(`"fields": {}`), or an entry holding only unknown keys fails the save
|
|
5816
|
+
with 422 `invalid_field_value`, and the error's `field` names the array
|
|
5817
|
+
(e.g. `pageProcessors[0].responseMapping.fields`).
|
|
5811
5818
|
- |-
|
|
5812
5819
|
responseMapping is fully replaced on PUT: omitting it resets the step
|
|
5813
5820
|
to empty `{"fields": [], "lists": []}`. Always send the complete
|
|
@@ -6794,6 +6801,15 @@ components:
|
|
|
6794
6801
|
description: When true, the API rejects all incoming requests.
|
|
6795
6802
|
examples:
|
|
6796
6803
|
- false
|
|
6804
|
+
failOnOfflineConnection:
|
|
6805
|
+
type: boolean
|
|
6806
|
+
description: |-
|
|
6807
|
+
When true, a call to a builder-mode API is refused before any step runs if a connection
|
|
6808
|
+
the API uses is offline. Set to true on create when omitted. Present on responses only
|
|
6809
|
+
when set: a PUT that omits it removes it, which turns the check off, and
|
|
6810
|
+
`PATCH /v1/apis/{_id}` on `/failOnOfflineConnection` changes it on its own.
|
|
6811
|
+
examples:
|
|
6812
|
+
- true
|
|
6797
6813
|
timeoutPeriod:
|
|
6798
6814
|
type: integer
|
|
6799
6815
|
minimum: 0
|
|
@@ -6801,6 +6817,9 @@ components:
|
|
|
6801
6817
|
description: |-
|
|
6802
6818
|
Request-timeout override in seconds (1–120). `0` is a sentinel meaning "use the
|
|
6803
6819
|
120-second default" — the server rewrites it on write, so a stored value is never 0.
|
|
6820
|
+
A call still running when the timeout passes answers 504 `api_timeout`. With
|
|
6821
|
+
`failOnOfflineConnection` false or absent, a step whose connection is offline holds the
|
|
6822
|
+
call until then.
|
|
6804
6823
|
examples:
|
|
6805
6824
|
- 120
|
|
6806
6825
|
- 30
|
|
@@ -7652,7 +7671,14 @@ components:
|
|
|
7652
7671
|
- /apis/v1/orders?status=open
|
|
7653
7672
|
statusCode:
|
|
7654
7673
|
type: integer
|
|
7655
|
-
description:
|
|
7674
|
+
description: |-
|
|
7675
|
+
HTTP status code the API responded with. A call refused because
|
|
7676
|
+
`failOnOfflineConnection` is true and a connection the API uses is offline is logged
|
|
7677
|
+
with 500 and one `apiCall` step in `error` status; the caller got
|
|
7678
|
+
`api_connection_offline` ("One or more connections used by this API are offline.
|
|
7679
|
+
Contact the API publisher and try again later."). Neither that response nor the
|
|
7680
|
+
step's log data names the connection: `GET /v1/apis/{_id}/connections` shows which
|
|
7681
|
+
ones read `offline: true`. A call that ran past `timeoutPeriod` is logged with 504.
|
|
7656
7682
|
examples:
|
|
7657
7683
|
- 200
|
|
7658
7684
|
traceKey:
|
|
@@ -10915,6 +10941,22 @@ components:
|
|
|
10915
10941
|
an `auth.type` `oauth` connection: 422 invalid_field_update "Removing _iClientId is
|
|
10916
10942
|
not allowed for oauth connections due to security reasons." — switch it to another
|
|
10917
10943
|
iClient instead.
|
|
10944
|
+
_tokenStoreId:
|
|
10945
|
+
type: string
|
|
10946
|
+
format: objectId
|
|
10947
|
+
readOnly: true
|
|
10948
|
+
description: |-
|
|
10949
|
+
Token store holding the expiring Shopify access token that this connection shares with
|
|
10950
|
+
the other connections of the same app and shop. Set only by the platform, and present
|
|
10951
|
+
only when set; no API route reads the store itself. Sending the field on POST, even as
|
|
10952
|
+
`null`, fails with 422 `token_store_id_not_writable`. On PUT or PATCH only a value
|
|
10953
|
+
different from the stored one fails the same way (any id, on a connection that has
|
|
10954
|
+
none), so sending it back unchanged or omitting it is accepted.
|
|
10955
|
+
x-celigo-ai-guidance:
|
|
10956
|
+
- |-
|
|
10957
|
+
When creating a connection from another connection's GET response, drop
|
|
10958
|
+
`http._tokenStoreId` from the body: a POST that carries it with any value, `null`
|
|
10959
|
+
included, fails with 422 `token_store_id_not_writable`.
|
|
10918
10960
|
_httpConnectorId:
|
|
10919
10961
|
type: string
|
|
10920
10962
|
format: objectId
|
package/dist/audit.yml
CHANGED
|
@@ -104,7 +104,6 @@ paths:
|
|
|
104
104
|
- import
|
|
105
105
|
- integration
|
|
106
106
|
- lookupcache
|
|
107
|
-
- mcpoauthprovider
|
|
108
107
|
- mcpserver
|
|
109
108
|
- networkpolicy
|
|
110
109
|
- notification
|
|
@@ -142,10 +141,9 @@ paths:
|
|
|
142
141
|
import: Import resource for writing data to a destination system.
|
|
143
142
|
integration: Integration workspace resource.
|
|
144
143
|
lookupcache: Lookup cache resource for in-memory key-value stores.
|
|
145
|
-
mcpoauthprovider: MCP OAuth provider resource.
|
|
146
144
|
mcpserver: MCP server resource for AI agent tool hosting.
|
|
147
145
|
networkpolicy: Network policy resource (IP allow/deny lists).
|
|
148
|
-
notification: Notification subscription resource.
|
|
146
|
+
notification: Notification subscription resource. Filtering on `alert` also returns these entries.
|
|
149
147
|
revision: Revision snapshot resource for version control.
|
|
150
148
|
role: End-user role resource.
|
|
151
149
|
script: Script resource for custom JavaScript hooks.
|
|
@@ -547,7 +545,6 @@ paths:
|
|
|
547
545
|
- import
|
|
548
546
|
- integration
|
|
549
547
|
- lookupcache
|
|
550
|
-
- mcpoauthprovider
|
|
551
548
|
- mcpserver
|
|
552
549
|
- notification
|
|
553
550
|
- revision
|
|
@@ -582,9 +579,8 @@ paths:
|
|
|
582
579
|
import: Import resource for writing data to a destination system.
|
|
583
580
|
integration: Integration workspace resource.
|
|
584
581
|
lookupcache: Lookup cache resource for in-memory key-value stores.
|
|
585
|
-
mcpoauthprovider: MCP OAuth provider resource.
|
|
586
582
|
mcpserver: MCP server resource for AI agent tool hosting.
|
|
587
|
-
notification: Notification subscription resource.
|
|
583
|
+
notification: Notification subscription resource. Filtering on `alert` also returns these entries.
|
|
588
584
|
revision: Revision snapshot resource for version control.
|
|
589
585
|
role: End-user role resource.
|
|
590
586
|
script: Script resource for custom JavaScript hooks.
|
|
@@ -822,7 +818,6 @@ paths:
|
|
|
822
818
|
- imports
|
|
823
819
|
- integrations
|
|
824
820
|
- lookupcaches
|
|
825
|
-
- mcpoauthproviders
|
|
826
821
|
- mcpservers
|
|
827
822
|
- networkpolicies
|
|
828
823
|
- revisions
|
|
@@ -850,9 +845,8 @@ paths:
|
|
|
850
845
|
iclients: iClient shared credential resources.
|
|
851
846
|
idpconfigs: End-user identity provider configuration resources.
|
|
852
847
|
imports: Import resources.
|
|
853
|
-
integrations: Integration workspace resources.
|
|
848
|
+
integrations: Integration workspace resources. The history also includes the alerts set on the integration or its flows, deleted ones too.
|
|
854
849
|
lookupcaches: Lookup cache resources.
|
|
855
|
-
mcpoauthproviders: MCP OAuth provider resources.
|
|
856
850
|
mcpservers: MCP server resources.
|
|
857
851
|
networkpolicies: Network policy resources.
|
|
858
852
|
revisions: Revision snapshot resources.
|
|
@@ -1060,7 +1054,6 @@ paths:
|
|
|
1060
1054
|
- imports
|
|
1061
1055
|
- integrations
|
|
1062
1056
|
- lookupcaches
|
|
1063
|
-
- mcpoauthproviders
|
|
1064
1057
|
- mcpservers
|
|
1065
1058
|
- networkpolicies
|
|
1066
1059
|
- revisions
|
|
@@ -1088,9 +1081,8 @@ paths:
|
|
|
1088
1081
|
iclients: iClient shared credential resources.
|
|
1089
1082
|
idpconfigs: End-user identity provider configuration resources.
|
|
1090
1083
|
imports: Import resources.
|
|
1091
|
-
integrations: Integration workspace resources.
|
|
1084
|
+
integrations: Integration workspace resources. The history also includes the alerts set on the integration or its flows, deleted ones too.
|
|
1092
1085
|
lookupcaches: Lookup cache resources.
|
|
1093
|
-
mcpoauthproviders: MCP OAuth provider resources.
|
|
1094
1086
|
mcpservers: MCP server resources.
|
|
1095
1087
|
networkpolicies: Network policy resources.
|
|
1096
1088
|
revisions: Revision snapshot resources.
|
|
@@ -1286,7 +1278,6 @@ paths:
|
|
|
1286
1278
|
- imports
|
|
1287
1279
|
- integrations
|
|
1288
1280
|
- lookupcaches
|
|
1289
|
-
- mcpoauthproviders
|
|
1290
1281
|
- mcpservers
|
|
1291
1282
|
- networkpolicies
|
|
1292
1283
|
- revisions
|
|
@@ -1312,9 +1303,8 @@ paths:
|
|
|
1312
1303
|
iclients: iClient shared credential resources.
|
|
1313
1304
|
idpconfigs: End-user identity provider configuration resources.
|
|
1314
1305
|
imports: Import resources.
|
|
1315
|
-
integrations: Integration workspace resources.
|
|
1306
|
+
integrations: Integration workspace resources. The export also includes the alerts set on the integration or its flows, deleted ones too.
|
|
1316
1307
|
lookupcaches: Lookup cache resources.
|
|
1317
|
-
mcpoauthproviders: MCP OAuth provider resources.
|
|
1318
1308
|
mcpservers: MCP server resources.
|
|
1319
1309
|
networkpolicies: Network policy resources.
|
|
1320
1310
|
revisions: Revision snapshot resources.
|
|
@@ -1377,7 +1367,10 @@ components:
|
|
|
1377
1367
|
properties:
|
|
1378
1368
|
fieldPath:
|
|
1379
1369
|
type: string
|
|
1380
|
-
description:
|
|
1370
|
+
description: |-
|
|
1371
|
+
Dot-path to the changed field (e.g., `settings.foo.bar`). On `alert` entries a recipient
|
|
1372
|
+
change is reported as `recipients`, with `oldValue` and `newValue` listing the recipients'
|
|
1373
|
+
email addresses instead of user ids.
|
|
1381
1374
|
examples:
|
|
1382
1375
|
- http.auth.token.token
|
|
1383
1376
|
oldValue:
|
|
@@ -1397,7 +1390,7 @@ components:
|
|
|
1397
1390
|
type: string
|
|
1398
1391
|
format: objectId
|
|
1399
1392
|
x-celigo-refModel: integrations
|
|
1400
|
-
description: Integration id context (for flow/sync-related events).
|
|
1393
|
+
description: Integration id context (for flow/sync-related and alert events).
|
|
1401
1394
|
examples:
|
|
1402
1395
|
- 60a2c4e6f321d800129a1a3c
|
|
1403
1396
|
_abstractFlowId:
|
|
@@ -1459,8 +1452,11 @@ components:
|
|
|
1459
1452
|
type: string
|
|
1460
1453
|
readOnly: true
|
|
1461
1454
|
description: |-
|
|
1462
|
-
Resource type that the audit entry applies to. `fileserver`
|
|
1463
|
-
returned entries and cannot be used as a
|
|
1455
|
+
Resource type that the audit entry applies to. `fileserver` and
|
|
1456
|
+
`mcpoauthprovider` appear only in returned entries and cannot be used as a
|
|
1457
|
+
`resourceType` filter. MCP OAuth providers have no per-resource audit route
|
|
1458
|
+
either, so their entries are read from `GET /v1/audit` without a
|
|
1459
|
+
`resourceType` filter.
|
|
1464
1460
|
enum:
|
|
1465
1461
|
- accesstoken
|
|
1466
1462
|
- agent
|
|
@@ -1542,6 +1538,15 @@ components:
|
|
|
1542
1538
|
description: Resource id the audit entry applies to.
|
|
1543
1539
|
examples:
|
|
1544
1540
|
- 69497ca1b40d3e24522a7f3c
|
|
1541
|
+
resourceName:
|
|
1542
|
+
type: string
|
|
1543
|
+
readOnly: true
|
|
1544
|
+
description: |-
|
|
1545
|
+
Display name of the alert, present on `alert` entries only: `<type label> - <flow name>`
|
|
1546
|
+
for a flow-level alert, `<type label> - All flows (<integration name>)` for an
|
|
1547
|
+
integration-level alert.
|
|
1548
|
+
examples:
|
|
1549
|
+
- Long runtime - All flows (Shopify to NetSuite)
|
|
1545
1550
|
source:
|
|
1546
1551
|
type: string
|
|
1547
1552
|
readOnly: true
|
|
@@ -1692,7 +1697,6 @@ components:
|
|
|
1692
1697
|
- import
|
|
1693
1698
|
- integration
|
|
1694
1699
|
- lookupcache
|
|
1695
|
-
- mcpoauthprovider
|
|
1696
1700
|
- mcpserver
|
|
1697
1701
|
- networkpolicy
|
|
1698
1702
|
- notification
|
|
@@ -1728,10 +1732,9 @@ components:
|
|
|
1728
1732
|
import: Import resource for writing data to a destination system.
|
|
1729
1733
|
integration: Integration workspace resource.
|
|
1730
1734
|
lookupcache: Lookup cache resource for in-memory key-value stores.
|
|
1731
|
-
mcpoauthprovider: MCP OAuth provider resource.
|
|
1732
1735
|
mcpserver: MCP server resource for AI agent tool hosting.
|
|
1733
1736
|
networkpolicy: Network policy resource (IP allow/deny lists).
|
|
1734
|
-
notification: Notification subscription resource.
|
|
1737
|
+
notification: Notification subscription resource. Filtering on `alert` also returns these entries.
|
|
1735
1738
|
revision: Revision snapshot resource for version control.
|
|
1736
1739
|
role: End-user role resource.
|
|
1737
1740
|
script: Script resource for custom JavaScript hooks.
|
|
@@ -1915,7 +1918,6 @@ components:
|
|
|
1915
1918
|
- import
|
|
1916
1919
|
- integration
|
|
1917
1920
|
- lookupcache
|
|
1918
|
-
- mcpoauthprovider
|
|
1919
1921
|
- mcpserver
|
|
1920
1922
|
- networkpolicy
|
|
1921
1923
|
- notification
|
|
@@ -1951,10 +1953,9 @@ components:
|
|
|
1951
1953
|
import: Import resource for writing data to a destination system.
|
|
1952
1954
|
integration: Integration workspace resource.
|
|
1953
1955
|
lookupcache: Lookup cache resource for in-memory key-value stores.
|
|
1954
|
-
mcpoauthprovider: MCP OAuth provider resource.
|
|
1955
1956
|
mcpserver: MCP server resource for AI agent tool hosting.
|
|
1956
1957
|
networkpolicy: Network policy resource (IP allow/deny lists).
|
|
1957
|
-
notification: Notification subscription resource.
|
|
1958
|
+
notification: Notification subscription resource. Filtering on `alert` also returns these entries.
|
|
1958
1959
|
revision: Revision snapshot resource for version control.
|
|
1959
1960
|
role: End-user role resource.
|
|
1960
1961
|
script: Script resource for custom JavaScript hooks.
|
package/dist/connection.yml
CHANGED
|
@@ -6763,6 +6763,22 @@ components:
|
|
|
6763
6763
|
an `auth.type` `oauth` connection: 422 invalid_field_update "Removing _iClientId is
|
|
6764
6764
|
not allowed for oauth connections due to security reasons." — switch it to another
|
|
6765
6765
|
iClient instead.
|
|
6766
|
+
_tokenStoreId:
|
|
6767
|
+
type: string
|
|
6768
|
+
format: objectId
|
|
6769
|
+
readOnly: true
|
|
6770
|
+
description: |-
|
|
6771
|
+
Token store holding the expiring Shopify access token that this connection shares with
|
|
6772
|
+
the other connections of the same app and shop. Set only by the platform, and present
|
|
6773
|
+
only when set; no API route reads the store itself. Sending the field on POST, even as
|
|
6774
|
+
`null`, fails with 422 `token_store_id_not_writable`. On PUT or PATCH only a value
|
|
6775
|
+
different from the stored one fails the same way (any id, on a connection that has
|
|
6776
|
+
none), so sending it back unchanged or omitting it is accepted.
|
|
6777
|
+
x-celigo-ai-guidance:
|
|
6778
|
+
- |-
|
|
6779
|
+
When creating a connection from another connection's GET response, drop
|
|
6780
|
+
`http._tokenStoreId` from the body: a POST that carries it with any value, `null`
|
|
6781
|
+
included, fails with 422 `token_store_id_not_writable`.
|
|
6766
6782
|
_httpConnectorId:
|
|
6767
6783
|
type: string
|
|
6768
6784
|
format: objectId
|
package/dist/enduser.yml
CHANGED
|
@@ -4799,6 +4799,22 @@ components:
|
|
|
4799
4799
|
an `auth.type` `oauth` connection: 422 invalid_field_update "Removing _iClientId is
|
|
4800
4800
|
not allowed for oauth connections due to security reasons." — switch it to another
|
|
4801
4801
|
iClient instead.
|
|
4802
|
+
_tokenStoreId:
|
|
4803
|
+
type: string
|
|
4804
|
+
format: objectId
|
|
4805
|
+
readOnly: true
|
|
4806
|
+
description: |-
|
|
4807
|
+
Token store holding the expiring Shopify access token that this connection shares with
|
|
4808
|
+
the other connections of the same app and shop. Set only by the platform, and present
|
|
4809
|
+
only when set; no API route reads the store itself. Sending the field on POST, even as
|
|
4810
|
+
`null`, fails with 422 `token_store_id_not_writable`. On PUT or PATCH only a value
|
|
4811
|
+
different from the stored one fails the same way (any id, on a connection that has
|
|
4812
|
+
none), so sending it back unchanged or omitting it is accepted.
|
|
4813
|
+
x-celigo-ai-guidance:
|
|
4814
|
+
- |-
|
|
4815
|
+
When creating a connection from another connection's GET response, drop
|
|
4816
|
+
`http._tokenStoreId` from the body: a POST that carries it with any value, `null`
|
|
4817
|
+
included, fails with 422 `token_store_id_not_writable`.
|
|
4802
4818
|
_httpConnectorId:
|
|
4803
4819
|
type: string
|
|
4804
4820
|
format: objectId
|
package/dist/filedefinition.yml
CHANGED
|
@@ -13,8 +13,9 @@ info:
|
|
|
13
13
|
They define how rows, columns, segments, and elements are parsed or generated,
|
|
14
14
|
including delimiters, padding, and hierarchical rule structures.
|
|
15
15
|
|
|
16
|
-
EDI file definitions (X12 and EDIFACT formats)
|
|
17
|
-
|
|
16
|
+
EDI file definitions (X12 and EDIFACT formats) carry a `globalId` that maps to a
|
|
17
|
+
known standard document definition; on an EDI-licensed account the server assigns
|
|
18
|
+
one when a create omits it.
|
|
18
19
|
servers:
|
|
19
20
|
- url: https://api.integrator.io
|
|
20
21
|
description: Production (US / default region)
|
|
@@ -36,7 +37,7 @@ tags:
|
|
|
36
37
|
|
|
37
38
|
Four formats are supported: `delimited` (CSV/TSV), `delimited/x12` (EDI X12),
|
|
38
39
|
`delimited/edifact` (EDI EDIFACT), and `fixed` (fixed-width). EDI formats
|
|
39
|
-
|
|
40
|
+
carry a `globalId` linking to a standard document definition.
|
|
40
41
|
|
|
41
42
|
## File definition schema
|
|
42
43
|
|
|
@@ -204,9 +205,10 @@ paths:
|
|
|
204
205
|
$ref: '#/components/responses/422-unprocessable-entity'
|
|
205
206
|
x-celigo-ai-guidance:
|
|
206
207
|
- |-
|
|
207
|
-
For EDI formats (`delimited/x12` or `delimited/edifact`)
|
|
208
|
-
|
|
209
|
-
reference a known standard document definition
|
|
208
|
+
For EDI formats (`delimited/x12` or `delimited/edifact`) on an EDI-licensed
|
|
209
|
+
account, the server assigns a `globalId` when the body omits one; a supplied
|
|
210
|
+
`globalId` must reference a known standard document definition, or the create
|
|
211
|
+
fails with 422 `invalid_global_id`.
|
|
210
212
|
- |-
|
|
211
213
|
For `format: fixed`, send `version`, `fixed.rowDelimiter` and `fixed.paddingChar`;
|
|
212
214
|
without them the create fails with 422 and nothing is saved. Columns are read in
|
|
@@ -274,7 +276,8 @@ paths:
|
|
|
274
276
|
Replaces the file definition with the provided configuration. This
|
|
275
277
|
is a full replace -- include all fields you want to keep. `format`
|
|
276
278
|
cannot be changed between `fixed` and `delimited` families after
|
|
277
|
-
creation, and `globalId` is immutable for EDI formats
|
|
279
|
+
creation, and `globalId` is immutable for EDI formats: a PUT that sends a
|
|
280
|
+
different value, or omits it, keeps the stored id.
|
|
278
281
|
operationId: updateFileDefinition
|
|
279
282
|
tags:
|
|
280
283
|
- File Definitions
|
|
@@ -1025,8 +1028,8 @@ components:
|
|
|
1025
1028
|
- fixed
|
|
1026
1029
|
x-enumDescriptions:
|
|
1027
1030
|
delimited: Standard delimited files (CSV, TSV, etc.).
|
|
1028
|
-
delimited/x12: EDI X12 format.
|
|
1029
|
-
delimited/edifact: EDI EDIFACT format.
|
|
1031
|
+
delimited/x12: EDI X12 format. Carries a `globalId`, assigned by the server when a create on an EDI-licensed account omits it.
|
|
1032
|
+
delimited/edifact: EDI EDIFACT format. Carries a `globalId`, assigned by the server when a create on an EDI-licensed account omits it.
|
|
1030
1033
|
fixed: Fixed-width positional format.
|
|
1031
1034
|
documentType:
|
|
1032
1035
|
type: string
|
|
@@ -1039,15 +1042,21 @@ components:
|
|
|
1039
1042
|
description: EDI document type for acknowledgement documents.
|
|
1040
1043
|
globalId:
|
|
1041
1044
|
type: string
|
|
1042
|
-
description:
|
|
1043
|
-
|
|
1044
|
-
|
|
1045
|
-
|
|
1046
|
-
|
|
1047
|
-
|
|
1048
|
-
creation
|
|
1045
|
+
description: |
|
|
1046
|
+
Global identifier mapping to a known EDI standard document definition.
|
|
1047
|
+
|
|
1048
|
+
For EDI formats (`delimited/x12` or `delimited/edifact`) on an account
|
|
1049
|
+
with an EDI license, a create that omits it gets one assigned from the
|
|
1050
|
+
EDI catalog, and a supplied value must be a catalog entry (an unknown one
|
|
1051
|
+
fails the create with 422 `invalid_global_id`). Immutable after creation:
|
|
1052
|
+
a PUT that sends a different value, or none, keeps the stored id.
|
|
1049
1053
|
examples:
|
|
1050
|
-
-
|
|
1054
|
+
- 3c7a8f2e-1234-5678-9abc-def012345678
|
|
1055
|
+
x-celigo-ai-guidance:
|
|
1056
|
+
- |-
|
|
1057
|
+
Send the catalog globalId of the document when you know it. When it is omitted the
|
|
1058
|
+
server picks the id, and a description naming another document type did not change
|
|
1059
|
+
the pick — an X12 create described as an 856 got the same id as a bare X12 create.
|
|
1051
1060
|
rules:
|
|
1052
1061
|
type: array
|
|
1053
1062
|
x-celigo-agent:
|