@celigo/api-specs 0.2.134 → 0.2.135

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/api.yml CHANGED
@@ -5015,6 +5015,12 @@ components:
5015
5015
  type: boolean
5016
5016
  description: When true, the connection has been taken offline and is skipped during flow execution.
5017
5017
  readOnly: true
5018
+ needsAuthorization:
5019
+ type: boolean
5020
+ readOnly: true
5021
+ description: |-
5022
+ OAuth handshake state. Celigo's OAuth callback sets it to `false` once the user consents
5023
+ and the tokens are stored (see `GET /v1/connection/{_id}/oauth2`).
5018
5024
  _sourceId:
5019
5025
  type: string
5020
5026
  format: objectId
@@ -6071,7 +6077,7 @@ components:
6071
6077
  OAuth 2.0 redirect URI (callback URL) registered with the API provider.
6072
6078
  Must exactly match the redirect URI configured in the OAuth application registration.
6073
6079
  examples:
6074
- - https://api.integrator.io/connection/oauth2callback
6080
+ - https://integrator.io/connection/oauth2callback
6075
6081
  useIClientFields:
6076
6082
  type: boolean
6077
6083
  description: |
@@ -9927,7 +9933,7 @@ components:
9927
9933
 
9928
9934
  ## REQUIRED FIELDS
9929
9935
  - pingFunction (name of the function that tests connection health)
9930
- - _stackId (set on the parent connection object — references the Celigo Stack)
9936
+ - _stackId (inside this object, as `wrapper._stackId` — references the Celigo Stack)
9931
9937
 
9932
9938
  ## CUSTOM FIELDS
9933
9939
  Use encrypted/unencrypted fields to store connection-specific configuration.
@@ -2438,7 +2438,8 @@ paths:
2438
2438
  Returns the buffered debug log stream for the connection — request/response pairs from
2439
2439
  recent exports, imports, and lookups that used it. Capture is gated by the connection's
2440
2440
  `debugDate`: logs are recorded only while `debugDate` is in the future, so enable it first
2441
- via `PUT /v1/connections/{_id}` or the buffer stays empty.
2441
+ with `PATCH /v1/connections/{_id}` on `/debugDate` (credential-safe, unlike a full `PUT`)
2442
+ or the buffer stays empty.
2442
2443
 
2443
2444
  The response is a plain-text stream (not JSON): each entry is a header line
2444
2445
  (`timestamp traceKey resourceType resourceId`) followed by a single-line JSON payload,
@@ -2494,11 +2495,11 @@ paths:
2494
2495
 
2495
2496
  Idempotent — works whether the buffer held entries, was already empty, or the given
2496
2497
  connection id does not exist. Does **not** clear the connection's `debugDate` — debug
2497
- capture remains enabled until `debugDate` expires or is removed via a PUT.
2498
+ capture remains enabled until `debugDate` expires or is removed.
2498
2499
 
2499
2500
  Useful between test runs to isolate logs for a single scenario. To fully
2500
- disable debug capture, also `PUT /v1/connections/{_id}` with `debugDate`
2501
- removed from the body.
2501
+ disable debug capture, also send `PATCH /v1/connections/{_id}` with a `remove`
2502
+ operation on `/debugDate`.
2502
2503
  parameters:
2503
2504
  - name: _id
2504
2505
  in: path
@@ -4126,6 +4127,12 @@ components:
4126
4127
  type: boolean
4127
4128
  description: When true, the connection has been taken offline and is skipped during flow execution.
4128
4129
  readOnly: true
4130
+ needsAuthorization:
4131
+ type: boolean
4132
+ readOnly: true
4133
+ description: |-
4134
+ OAuth handshake state. Celigo's OAuth callback sets it to `false` once the user consents
4135
+ and the tokens are stored (see `GET /v1/connection/{_id}/oauth2`).
4129
4136
  _sourceId:
4130
4137
  type: string
4131
4138
  format: objectId
@@ -5182,7 +5189,7 @@ components:
5182
5189
  OAuth 2.0 redirect URI (callback URL) registered with the API provider.
5183
5190
  Must exactly match the redirect URI configured in the OAuth application registration.
5184
5191
  examples:
5185
- - https://api.integrator.io/connection/oauth2callback
5192
+ - https://integrator.io/connection/oauth2callback
5186
5193
  useIClientFields:
5187
5194
  type: boolean
5188
5195
  description: |
@@ -9038,7 +9045,7 @@ components:
9038
9045
 
9039
9046
  ## REQUIRED FIELDS
9040
9047
  - pingFunction (name of the function that tests connection health)
9041
- - _stackId (set on the parent connection object — references the Celigo Stack)
9048
+ - _stackId (inside this object, as `wrapper._stackId` — references the Celigo Stack)
9042
9049
 
9043
9050
  ## CUSTOM FIELDS
9044
9051
  Use encrypted/unencrypted fields to store connection-specific configuration.
@@ -10441,7 +10448,7 @@ components:
10441
10448
  Embeds a one-time token in the `state` query parameter that expires quickly and is
10442
10449
  invalidated after a single use.
10443
10450
  examples:
10444
- - https://login.example.com/oauth2/authorize?response_type=code&client_id=0oa1b2c3d4EXAMPLE5&redirect_uri=https%3A%2F%2Fapi.integrator.io%2Fconnection%2Foauth2callback&scope=read+write&state=eyJfY29ubmVjdGlvbklkIjoiNjE1ZGZhMDc0Mjc2MzY3MTI3NWI3MGFiIn0
10451
+ - https://login.example.com/oauth2/authorize?response_type=code&client_id=0oa1b2c3d4EXAMPLE5&redirect_uri=https%3A%2F%2Fintegrator.io%2Fconnection%2Foauth2callback&scope=read+write&state=eyJfY29ubmVjdGlvbklkIjoiNjE1ZGZhMDc0Mjc2MzY3MTI3NWI3MGFiIn0
10445
10452
  DependencyEntry:
10446
10453
  type: object
10447
10454
  description: A single resource that depends on the queried resource.
package/dist/enduser.yml CHANGED
@@ -2227,6 +2227,12 @@ components:
2227
2227
  type: boolean
2228
2228
  description: When true, the connection has been taken offline and is skipped during flow execution.
2229
2229
  readOnly: true
2230
+ needsAuthorization:
2231
+ type: boolean
2232
+ readOnly: true
2233
+ description: |-
2234
+ OAuth handshake state. Celigo's OAuth callback sets it to `false` once the user consents
2235
+ and the tokens are stored (see `GET /v1/connection/{_id}/oauth2`).
2230
2236
  _sourceId:
2231
2237
  type: string
2232
2238
  format: objectId
@@ -3283,7 +3289,7 @@ components:
3283
3289
  OAuth 2.0 redirect URI (callback URL) registered with the API provider.
3284
3290
  Must exactly match the redirect URI configured in the OAuth application registration.
3285
3291
  examples:
3286
- - https://api.integrator.io/connection/oauth2callback
3292
+ - https://integrator.io/connection/oauth2callback
3287
3293
  useIClientFields:
3288
3294
  type: boolean
3289
3295
  description: |
@@ -7139,7 +7145,7 @@ components:
7139
7145
 
7140
7146
  ## REQUIRED FIELDS
7141
7147
  - pingFunction (name of the function that tests connection health)
7142
- - _stackId (set on the parent connection object — references the Celigo Stack)
7148
+ - _stackId (inside this object, as `wrapper._stackId` — references the Celigo Stack)
7143
7149
 
7144
7150
  ## CUSTOM FIELDS
7145
7151
  Use encrypted/unencrypted fields to store connection-specific configuration.
package/dist/iclient.yml CHANGED
@@ -324,7 +324,9 @@ paths:
324
324
  account: every update must include the full JSON key. An Azure
325
325
  service principal keeps its stored `clientSecret` or `certificate`
326
326
  when the field is omitted — only a new value replaces it, and
327
- `certificate` is never returned.
327
+ `certificate` is never returned. Connections work the other way:
328
+ re-sending the mask on `PUT /v1/connections/{_id}` clears the stored
329
+ credential.
328
330
  operationId: updateIClient
329
331
  tags:
330
332
  - iClients
@@ -487,8 +489,9 @@ paths:
487
489
  x-internal: false
488
490
  summary: Delete an iClient
489
491
  description: |-
490
- Permanently deletes an iClient. Blocked if the iClient is still
491
- referenced by a connection.
492
+ Permanently deletes an iClient. Blocked while any connection references
493
+ it, including a deleted connection still in the recycle bin: purge that
494
+ connection with `DELETE /v1/recycleBinTTL/connections/{_id}` first.
492
495
  operationId: deleteIClient
493
496
  tags:
494
497
  - iClients
@@ -508,7 +511,20 @@ paths:
508
511
  '404':
509
512
  $ref: '#/components/responses/404-not-found'
510
513
  '422':
511
- $ref: '#/components/responses/422-unprocessable-entity'
514
+ description: |-
515
+ A connection still references the iClient. A deleted connection in the
516
+ recycle bin counts until it is purged.
517
+ content:
518
+ application/json:
519
+ schema:
520
+ $ref: '#/components/schemas/Error'
521
+ examples:
522
+ referencedByBinnedConnection:
523
+ summary: A deleted connection still in the recycle bin references the iClient
524
+ value:
525
+ errors:
526
+ - code: delete_not_allowed
527
+ message: 'this document is referenced by Connection : 6a1b2c3d4e5f60718293a4b5'
512
528
  /v1/iclients/{_id}/dependencies:
513
529
  get:
514
530
  x-internal: false
@@ -1366,7 +1382,7 @@ components:
1366
1382
  It is used in OAuth 2.0 authorization flows to receive authorization codes or
1367
1383
  access tokens securely.
1368
1384
  examples:
1369
- - https://api.integrator.io/connection/oauth2callback
1385
+ - https://integrator.io/connection/oauth2callback
1370
1386
  - https://client.example.com/callback
1371
1387
  - https://app.example.com/oauth2/callback
1372
1388
  - https://localhost:8080/auth/callback
@@ -2165,7 +2181,7 @@ components:
2165
2181
  - |-
2166
2182
  ## IMPLEMENTATION GUIDANCE:
2167
2183
  - Provide the plain password value here to set/update it.
2168
- - To keep the existing password unchanged during an update, omit this field (or keep `"******"` as-is if returned).
2184
+ - To keep the stored password on a PUT, re-send `"******"` (the masked value GET returns) unchanged; never omit this field to keep it.
2169
2185
  - |-
2170
2186
  Use `password` for the OAuth2 password value used with the password grant;
2171
2187
  this is the value provided to configure or update the iClient,
@@ -3166,7 +3182,7 @@ components:
3166
3182
  - |-
3167
3183
  ## IMPLEMENTATION GUIDANCE:
3168
3184
  - Provide the plaintext consumer key here to set/update it.
3169
- - To keep the existing value unchanged during an update, omit this field (or keep `"******"` as-is if returned).
3185
+ - To keep the stored value on a PUT, re-send `"******"` (the masked value GET returns) unchanged; never omit this field to keep it.
3170
3186
  - |-
3171
3187
  Set the NetSuite consumer key value used for authentication;
3172
3188
  provide this value to configure or update the iClient.
@@ -3192,7 +3208,7 @@ components:
3192
3208
  - |-
3193
3209
  ## IMPLEMENTATION GUIDANCE:
3194
3210
  - Provide the plaintext consumer secret here to set/update it.
3195
- - To keep the existing value unchanged during an update, omit this field (or keep `"******"` as-is if returned).
3211
+ - To keep the stored value on a PUT, re-send `"******"` (the masked value GET returns) unchanged; never omit this field to keep it.
3196
3212
  - |-
3197
3213
  The NetSuite consumer secret value used for authentication;
3198
3214
  provide this value to configure or update the iClient.
@@ -3336,7 +3352,7 @@ components:
3336
3352
  - |-
3337
3353
  ## IMPLEMENTATION GUIDANCE:
3338
3354
  - Provide the plain client secret value here to set/update it.
3339
- - To keep the existing secret unchanged during an update, omit this field (or keep `"******"` as-is if returned).
3355
+ - To keep the stored secret on a PUT, re-send `"******"` (the masked value GET returns) unchanged; never omit this field to keep it.
3340
3356
  - |-
3341
3357
  Use the Salesforce OAuth **client secret** value to configure or update the Salesforce iClient;
3342
3358
  integrator.io stores this secret encrypted at rest internally (for example as
@@ -3425,7 +3441,7 @@ components:
3425
3441
  - |-
3426
3442
  ## IMPLEMENTATION GUIDANCE:
3427
3443
  - Provide the plaintext private key value here to set/update it (often PEM formatted).
3428
- - To keep the existing private key unchanged during an update, omit this field (or keep `"******"` as-is if returned).
3444
+ - To keep the stored private key on a PUT, re-send `"******"` (the masked value GET returns) unchanged; never omit this field to keep it.
3429
3445
  - |-
3430
3446
  Set the Salesforce private key value used for authentication flows such as JWT
3431
3447
  bearer token OAuth;
@@ -3693,7 +3709,7 @@ components:
3693
3709
  - |-
3694
3710
  ## IMPLEMENTATION GUIDANCE:
3695
3711
  - Provide the plaintext certificate ID value here to set/update it.
3696
- - To keep the existing value unchanged during an update, omit this field (or keep `"******"` as-is if returned).
3712
+ - To keep the stored value on a PUT, re-send `"******"` (the masked value GET returns) unchanged; never omit this field to keep it.
3697
3713
  - |-
3698
3714
  Use the eBay certificate ID value for authentication;
3699
3715
  this is the value you provide to configure or update the iClient. integrator.io
@@ -3906,7 +3922,7 @@ components:
3906
3922
  - |-
3907
3923
  ## IMPLEMENTATION GUIDANCE:
3908
3924
  - Provide the plaintext secret key value here to set/update it.
3909
- - To keep the existing value unchanged during an update, omit this field (or keep `"******"` as-is if returned).
3925
+ - To keep the stored value on a PUT, re-send `"******"` (the masked value GET returns) unchanged; never omit this field to keep it.
3910
3926
  - |-
3911
3927
  Use the Amazon MWS secret key value for authentication;
3912
3928
  provide this value to configure or update the iClient.
@@ -4555,18 +4571,5 @@ components:
4555
4571
  errors:
4556
4572
  - code: not_found
4557
4573
  message: The requested resource was not found.
4558
- 422-unprocessable-entity:
4559
- description: |
4560
- Unprocessable entity. The request was well-formed but was unable to be followed due to semantic errors.
4561
- content:
4562
- application/json:
4563
- schema:
4564
- $ref: '#/components/schemas/Error'
4565
- examples:
4566
- default:
4567
- value:
4568
- errors:
4569
- - code: unprocessable_entity
4570
- message: The request could not be processed due to a semantic error.
4571
4574
  x-enable-proxy: true
4572
4575
  x-internal: false
@@ -4052,6 +4052,12 @@ components:
4052
4052
  type: boolean
4053
4053
  description: When true, the connection has been taken offline and is skipped during flow execution.
4054
4054
  readOnly: true
4055
+ needsAuthorization:
4056
+ type: boolean
4057
+ readOnly: true
4058
+ description: |-
4059
+ OAuth handshake state. Celigo's OAuth callback sets it to `false` once the user consents
4060
+ and the tokens are stored (see `GET /v1/connection/{_id}/oauth2`).
4055
4061
  _sourceId:
4056
4062
  type: string
4057
4063
  format: objectId
@@ -5108,7 +5114,7 @@ components:
5108
5114
  OAuth 2.0 redirect URI (callback URL) registered with the API provider.
5109
5115
  Must exactly match the redirect URI configured in the OAuth application registration.
5110
5116
  examples:
5111
- - https://api.integrator.io/connection/oauth2callback
5117
+ - https://integrator.io/connection/oauth2callback
5112
5118
  useIClientFields:
5113
5119
  type: boolean
5114
5120
  description: |
@@ -8964,7 +8970,7 @@ components:
8964
8970
 
8965
8971
  ## REQUIRED FIELDS
8966
8972
  - pingFunction (name of the function that tests connection health)
8967
- - _stackId (set on the parent connection object — references the Celigo Stack)
8973
+ - _stackId (inside this object, as `wrapper._stackId` — references the Celigo Stack)
8968
8974
 
8969
8975
  ## CUSTOM FIELDS
8970
8976
  Use encrypted/unencrypted fields to store connection-specific configuration.
package/dist/tool.yml CHANGED
@@ -7380,6 +7380,12 @@ components:
7380
7380
  type: boolean
7381
7381
  description: When true, the connection has been taken offline and is skipped during flow execution.
7382
7382
  readOnly: true
7383
+ needsAuthorization:
7384
+ type: boolean
7385
+ readOnly: true
7386
+ description: |-
7387
+ OAuth handshake state. Celigo's OAuth callback sets it to `false` once the user consents
7388
+ and the tokens are stored (see `GET /v1/connection/{_id}/oauth2`).
7383
7389
  _sourceId:
7384
7390
  type: string
7385
7391
  format: objectId
@@ -8436,7 +8442,7 @@ components:
8436
8442
  OAuth 2.0 redirect URI (callback URL) registered with the API provider.
8437
8443
  Must exactly match the redirect URI configured in the OAuth application registration.
8438
8444
  examples:
8439
- - https://api.integrator.io/connection/oauth2callback
8445
+ - https://integrator.io/connection/oauth2callback
8440
8446
  useIClientFields:
8441
8447
  type: boolean
8442
8448
  description: |
@@ -12292,7 +12298,7 @@ components:
12292
12298
 
12293
12299
  ## REQUIRED FIELDS
12294
12300
  - pingFunction (name of the function that tests connection health)
12295
- - _stackId (set on the parent connection object — references the Celigo Stack)
12301
+ - _stackId (inside this object, as `wrapper._stackId` — references the Celigo Stack)
12296
12302
 
12297
12303
  ## CUSTOM FIELDS
12298
12304
  Use encrypted/unencrypted fields to store connection-specific configuration.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@celigo/api-specs",
3
- "version": "0.2.134",
3
+ "version": "0.2.135",
4
4
  "private": false,
5
5
  "description": "Public OpenAPI bundles (dist/) and the celigo-cli lint schema pack (schemas.json).",
6
6
  "keywords": [
package/schemas.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "provenance": {
3
3
  "repo": "celigo/integrator-api-specs",
4
- "iasCommit": "86f54b3d",
4
+ "iasCommit": "db3dbe3d",
5
5
  "generatedAt": "2026-10-21"
6
6
  },
7
7
  "roots": {
@@ -2275,6 +2275,7 @@
2275
2275
  "lastModified": 1,
2276
2276
  "microServices": 224,
2277
2277
  "name": 1,
2278
+ "needsAuthorization": 9,
2278
2279
  "offline": 9,
2279
2280
  "pgp": 220,
2280
2281
  "queues": 226,
@@ -3626,6 +3627,7 @@
3626
3627
  "microServices": 224,
3627
3628
  "mongodb": 291,
3628
3629
  "name": 1,
3630
+ "needsAuthorization": 9,
3629
3631
  "netsuite": 232,
3630
3632
  "offline": 9,
3631
3633
  "pgp": 220,