@celigo/api-specs 0.2.116 → 0.2.118
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 +9 -12
- package/dist/iclient.yml +3 -3
- package/dist/sync.yml +33 -8
- package/dist/tool.yml +9 -12
- package/package.json +1 -1
- package/schemas.json +2 -2
package/dist/export.yml
CHANGED
|
@@ -1714,18 +1714,18 @@ components:
|
|
|
1714
1714
|
### Common implementations
|
|
1715
1715
|
|
|
1716
1716
|
```
|
|
1717
|
-
"token": "
|
|
1717
|
+
"token": "3a7c4f8b2e9d1a5c6b3e7d9fEXAMPLE"
|
|
1718
1718
|
```
|
|
1719
1719
|
|
|
1720
1720
|
```
|
|
1721
|
-
"token": "
|
|
1721
|
+
"token": "whsec_8fb2e91a5c6b3e7dEXAMPLE"
|
|
1722
1722
|
```
|
|
1723
1723
|
|
|
1724
1724
|
IMPORTANT: Never share this token in public repositories or documentation.
|
|
1725
1725
|
Treat it as a sensitive credential similar to a password.
|
|
1726
1726
|
examples:
|
|
1727
1727
|
- verification_token_abcdef
|
|
1728
|
-
-
|
|
1728
|
+
- whsec_8fb2e91a5c6b3e7dEXAMPLE
|
|
1729
1729
|
algorithm:
|
|
1730
1730
|
type: string
|
|
1731
1731
|
description: Hashing algorithm used to validate HMAC signatures when `verify` is `hmac`. Must match the algorithm the webhook sender uses — a mismatch causes every request to be rejected. Use `sha256` unless the provider explicitly requires another value.
|
|
@@ -1866,19 +1866,19 @@ components:
|
|
|
1866
1866
|
### Common implementations
|
|
1867
1867
|
|
|
1868
1868
|
```
|
|
1869
|
-
"key": "
|
|
1869
|
+
"key": "whsec_3a7c4f8b2e9d1a5c6b3e7dEXAMPLE"
|
|
1870
1870
|
```
|
|
1871
1871
|
|
|
1872
1872
|
```
|
|
1873
|
-
"key": "
|
|
1873
|
+
"key": "9d1a5c6b3e7d9f2a1c5b8e3aEXAMPLE"
|
|
1874
1874
|
```
|
|
1875
1875
|
|
|
1876
1876
|
IMPORTANT: This key should be treated as a highly sensitive credential,
|
|
1877
1877
|
similar to a private key or password. It should never be exposed publicly
|
|
1878
1878
|
or logged in application logs.
|
|
1879
1879
|
examples:
|
|
1880
|
-
-
|
|
1881
|
-
-
|
|
1880
|
+
- whsec_3a7c4f8b2e9d1a5c6b3e7dEXAMPLE
|
|
1881
|
+
- 9d1a5c6b3e7d9f2a1c5b8e3aEXAMPLE
|
|
1882
1882
|
header:
|
|
1883
1883
|
type: string
|
|
1884
1884
|
description: Name of the request header that carries the HMAC signature when `verify` is `hmac`. Must match the header name the webhook sender uses (header names are case-insensitive); requests without this header are rejected with a 401. Signature prefixes in the header value (such as `sha256=`) are handled automatically.
|
|
@@ -2104,12 +2104,9 @@ components:
|
|
|
2104
2104
|
|
|
2105
2105
|
Example header:
|
|
2106
2106
|
```
|
|
2107
|
-
Authorization: Basic
|
|
2107
|
+
Authorization: Basic base64(webhook_user:webhook_password)
|
|
2108
2108
|
```
|
|
2109
2109
|
|
|
2110
|
-
Where "d2ViaG9va191c2VyOndlYmhvb2tfcGFzc3dvcmQ=" is the base64 encoding of
|
|
2111
|
-
"webhook_user:webhook_password".
|
|
2112
|
-
|
|
2113
2110
|
### Security considerations
|
|
2114
2111
|
|
|
2115
2112
|
Basic Authentication:
|
|
@@ -2160,7 +2157,7 @@ components:
|
|
|
2160
2157
|
Never share it in public repositories, documentation, or logs. Always use
|
|
2161
2158
|
HTTPS for webhooks using Basic Authentication to prevent credential interception.
|
|
2162
2159
|
examples:
|
|
2163
|
-
- xC7!rTp2@bN9$
|
|
2160
|
+
- xC7!rTp2@bN9$EXAMPLE
|
|
2164
2161
|
- webhook_secure_pass_123
|
|
2165
2162
|
successStatusCode:
|
|
2166
2163
|
type: integer
|
package/dist/iclient.yml
CHANGED
|
@@ -3002,7 +3002,7 @@ components:
|
|
|
3002
3002
|
- Use this field to comply with specific OAuth 2.0 server requirements for token revocation.
|
|
3003
3003
|
- |-
|
|
3004
3004
|
## EXAMPLES:
|
|
3005
|
-
- `Authorization: Basic
|
|
3005
|
+
- `Authorization: Basic base64(client_id:client_secret)`
|
|
3006
3006
|
- `Content-Type: application/x-www-form-urlencoded`
|
|
3007
3007
|
- `X-Custom-Header: customValue`
|
|
3008
3008
|
- |-
|
|
@@ -3072,7 +3072,7 @@ components:
|
|
|
3072
3072
|
x-celigo-ai-guidance:
|
|
3073
3073
|
- |-
|
|
3074
3074
|
## EXAMPLES:
|
|
3075
|
-
- `{"password":"
|
|
3075
|
+
- `{"password":"my-password-EXAMPLE"}`
|
|
3076
3076
|
- `{"token":"x7if4nkovhgr63ghp"}`
|
|
3077
3077
|
- |-
|
|
3078
3078
|
## IMPORTANT NOTES:
|
|
@@ -4136,7 +4136,7 @@ components:
|
|
|
4136
4136
|
- |-
|
|
4137
4137
|
## EXAMPLES:
|
|
4138
4138
|
- eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
|
|
4139
|
-
- eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJleGFtcGxlLmNvbSIsInN1YiI6IjEyMzQ1Njc4OTAiLCJleHAiOjE2MjQ2MjQwMDB9.
|
|
4139
|
+
- eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJleGFtcGxlLmNvbSIsInN1YiI6IjEyMzQ1Njc4OTAiLCJleHAiOjE2MjQ2MjQwMDB9.EXAMPLEsignature
|
|
4140
4140
|
- |-
|
|
4141
4141
|
## DEPENDENCY CHAIN:
|
|
4142
4142
|
- Depends on the authentication mechanism generating the JWT.
|
package/dist/sync.yml
CHANGED
|
@@ -2547,6 +2547,11 @@ paths:
|
|
|
2547
2547
|
Returns the catalog of applications that can be used as the **source** of a sync — the system
|
|
2548
2548
|
a sync extracts records from. Use the returned `id` as the source application when building a
|
|
2549
2549
|
sync, and `category` to group the options in a picker.
|
|
2550
|
+
|
|
2551
|
+
The list is the set of applications that offer object-based extraction (a browsable catalog of
|
|
2552
|
+
tables/objects, no export resource needed); HTTP connectors join it as they are enabled, so read
|
|
2553
|
+
it at build time rather than caching it. An application missing from the list can still feed a
|
|
2554
|
+
sync through export-backed datasets — see `GET /v1/di/metadata/connections/{_connectionId}/datasets`.
|
|
2550
2555
|
tags:
|
|
2551
2556
|
- Syncs
|
|
2552
2557
|
operationId: listSyncSources
|
|
@@ -2565,7 +2570,10 @@ paths:
|
|
|
2565
2570
|
properties:
|
|
2566
2571
|
id:
|
|
2567
2572
|
type: string
|
|
2568
|
-
description:
|
|
2573
|
+
description: |-
|
|
2574
|
+
Application identifier to use as the sync source. For HTTP-connector-backed
|
|
2575
|
+
sources this is the connector's display name, identical to `displayName`
|
|
2576
|
+
(for example `Stripe`, `Loop Returns`), not a lowercase key.
|
|
2569
2577
|
examples:
|
|
2570
2578
|
- salesforce
|
|
2571
2579
|
category:
|
|
@@ -2621,7 +2629,7 @@ paths:
|
|
|
2621
2629
|
category: Sales & Marketing
|
|
2622
2630
|
- id: netsuite
|
|
2623
2631
|
category: Sales & Marketing
|
|
2624
|
-
- id:
|
|
2632
|
+
- id: Stripe
|
|
2625
2633
|
category: HTTP Connector
|
|
2626
2634
|
displayName: Stripe
|
|
2627
2635
|
source: httpConnectorMetadata
|
|
@@ -2740,7 +2748,14 @@ paths:
|
|
|
2740
2748
|
properties:
|
|
2741
2749
|
datasets:
|
|
2742
2750
|
type: array
|
|
2743
|
-
description:
|
|
2751
|
+
description: |-
|
|
2752
|
+
Tables/objects the source application exposes. Present unless `type` is `exports`.
|
|
2753
|
+
Empty — with a `200`, not an error — when the connection offers no object-based
|
|
2754
|
+
extraction: an HTTP connector that `GET /v1/di/metadata/sources` does not list, an
|
|
2755
|
+
HTTP connection with no connector, or a connection on a listed connector whose API
|
|
2756
|
+
or version is not the one the sources entry names (`httpConnector._apiId` /
|
|
2757
|
+
`_versionId`). Such a connection feeds a sync only through export-backed datasets
|
|
2758
|
+
(`exports`).
|
|
2744
2759
|
items:
|
|
2745
2760
|
type: object
|
|
2746
2761
|
description: One syncable table/object in the source application.
|
|
@@ -3878,8 +3893,13 @@ components:
|
|
|
3878
3893
|
format: objectId
|
|
3879
3894
|
x-celigo-refModel: connections
|
|
3880
3895
|
description: |-
|
|
3881
|
-
Connection to the source application.
|
|
3882
|
-
|
|
3896
|
+
Connection to the source application. Any application can be the source; the
|
|
3897
|
+
connection's dataset mode is read from
|
|
3898
|
+
`GET /v1/di/metadata/connections/{_connectionId}/datasets`: a non-empty
|
|
3899
|
+
`datasets` array is object mode, an empty one means the connection feeds the
|
|
3900
|
+
sync through export-backed datasets (`isExport: true`) only — including a
|
|
3901
|
+
connection on a listed HTTP connector whose API or version is not the one
|
|
3902
|
+
`GET /v1/di/metadata/sources` names.
|
|
3883
3903
|
examples:
|
|
3884
3904
|
- 6a2a95909e994395f3c2a4e6
|
|
3885
3905
|
destination:
|
|
@@ -4063,9 +4083,14 @@ components:
|
|
|
4063
4083
|
format: objectId
|
|
4064
4084
|
x-celigo-refModel: connections
|
|
4065
4085
|
description: |-
|
|
4066
|
-
Connection to the source application.
|
|
4067
|
-
|
|
4068
|
-
|
|
4086
|
+
Connection to the source application. Any application can be the source; the
|
|
4087
|
+
connection's dataset mode is read from
|
|
4088
|
+
`GET /v1/di/metadata/connections/{_connectionId}/datasets`: a non-empty
|
|
4089
|
+
`datasets` array is object mode, an empty one means the connection feeds the
|
|
4090
|
+
sync through export-backed datasets (`isExport: true`) only — including a
|
|
4091
|
+
connection on a listed HTTP connector whose API or version is not the one
|
|
4092
|
+
`GET /v1/di/metadata/sources` names. Omitting it fails with
|
|
4093
|
+
`422 missing_source_connection`.
|
|
4069
4094
|
examples:
|
|
4070
4095
|
- 6a2a95909e994395f3c2a4e6
|
|
4071
4096
|
destination:
|
package/dist/tool.yml
CHANGED
|
@@ -26365,18 +26365,18 @@ components:
|
|
|
26365
26365
|
### Common implementations
|
|
26366
26366
|
|
|
26367
26367
|
```
|
|
26368
|
-
"token": "
|
|
26368
|
+
"token": "3a7c4f8b2e9d1a5c6b3e7d9fEXAMPLE"
|
|
26369
26369
|
```
|
|
26370
26370
|
|
|
26371
26371
|
```
|
|
26372
|
-
"token": "
|
|
26372
|
+
"token": "whsec_8fb2e91a5c6b3e7dEXAMPLE"
|
|
26373
26373
|
```
|
|
26374
26374
|
|
|
26375
26375
|
IMPORTANT: Never share this token in public repositories or documentation.
|
|
26376
26376
|
Treat it as a sensitive credential similar to a password.
|
|
26377
26377
|
examples:
|
|
26378
26378
|
- verification_token_abcdef
|
|
26379
|
-
-
|
|
26379
|
+
- whsec_8fb2e91a5c6b3e7dEXAMPLE
|
|
26380
26380
|
algorithm:
|
|
26381
26381
|
type: string
|
|
26382
26382
|
description: Hashing algorithm used to validate HMAC signatures when `verify` is `hmac`. Must match the algorithm the webhook sender uses — a mismatch causes every request to be rejected. Use `sha256` unless the provider explicitly requires another value.
|
|
@@ -26517,19 +26517,19 @@ components:
|
|
|
26517
26517
|
### Common implementations
|
|
26518
26518
|
|
|
26519
26519
|
```
|
|
26520
|
-
"key": "
|
|
26520
|
+
"key": "whsec_3a7c4f8b2e9d1a5c6b3e7dEXAMPLE"
|
|
26521
26521
|
```
|
|
26522
26522
|
|
|
26523
26523
|
```
|
|
26524
|
-
"key": "
|
|
26524
|
+
"key": "9d1a5c6b3e7d9f2a1c5b8e3aEXAMPLE"
|
|
26525
26525
|
```
|
|
26526
26526
|
|
|
26527
26527
|
IMPORTANT: This key should be treated as a highly sensitive credential,
|
|
26528
26528
|
similar to a private key or password. It should never be exposed publicly
|
|
26529
26529
|
or logged in application logs.
|
|
26530
26530
|
examples:
|
|
26531
|
-
-
|
|
26532
|
-
-
|
|
26531
|
+
- whsec_3a7c4f8b2e9d1a5c6b3e7dEXAMPLE
|
|
26532
|
+
- 9d1a5c6b3e7d9f2a1c5b8e3aEXAMPLE
|
|
26533
26533
|
header:
|
|
26534
26534
|
type: string
|
|
26535
26535
|
description: Name of the request header that carries the HMAC signature when `verify` is `hmac`. Must match the header name the webhook sender uses (header names are case-insensitive); requests without this header are rejected with a 401. Signature prefixes in the header value (such as `sha256=`) are handled automatically.
|
|
@@ -26755,12 +26755,9 @@ components:
|
|
|
26755
26755
|
|
|
26756
26756
|
Example header:
|
|
26757
26757
|
```
|
|
26758
|
-
Authorization: Basic
|
|
26758
|
+
Authorization: Basic base64(webhook_user:webhook_password)
|
|
26759
26759
|
```
|
|
26760
26760
|
|
|
26761
|
-
Where "d2ViaG9va191c2VyOndlYmhvb2tfcGFzc3dvcmQ=" is the base64 encoding of
|
|
26762
|
-
"webhook_user:webhook_password".
|
|
26763
|
-
|
|
26764
26761
|
### Security considerations
|
|
26765
26762
|
|
|
26766
26763
|
Basic Authentication:
|
|
@@ -26811,7 +26808,7 @@ components:
|
|
|
26811
26808
|
Never share it in public repositories, documentation, or logs. Always use
|
|
26812
26809
|
HTTPS for webhooks using Basic Authentication to prevent credential interception.
|
|
26813
26810
|
examples:
|
|
26814
|
-
- xC7!rTp2@bN9$
|
|
26811
|
+
- xC7!rTp2@bN9$EXAMPLE
|
|
26815
26812
|
- webhook_secure_pass_123
|
|
26816
26813
|
successStatusCode:
|
|
26817
26814
|
type: integer
|
package/package.json
CHANGED