@celigo/api-specs 0.2.38 → 0.2.40

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/account.yml CHANGED
@@ -103,7 +103,9 @@ paths:
103
103
  description: |-
104
104
  Returns every account that other users have shared with the current
105
105
  user. This is the inverse of `GET /v1/ashares`, which lists users
106
- who have access to *your* account.
106
+ who have access to *your* account. Respond to a pending invitation
107
+ with `PUT /v1/ashares/{_id}/accept` or `PUT /v1/ashares/{_id}/dismiss`;
108
+ leave an account with `DELETE /v1/shared/ashares/{_id}`.
107
109
  responses:
108
110
  '200':
109
111
  description: Array of shared-account entries.
@@ -142,6 +144,47 @@ paths:
142
144
  description: No accounts are shared with the current user.
143
145
  '401':
144
146
  $ref: '#/components/responses/401-unauthorized'
147
+ /v1/shared/ashares/{_id}:
148
+ delete:
149
+ x-internal: false
150
+ operationId: deleteSharedAccount
151
+ tags:
152
+ - Account
153
+ summary: Leave a shared account
154
+ description: |-
155
+ Revokes the current user's own access to an account that was shared with
156
+ them by deleting the share record. Leaving an administrator share also
157
+ removes the matching shares in the owner's other environments. The only
158
+ share a user holds cannot be deleted unless that account requires SSO for
159
+ the user — dismiss it through `PUT /v1/ashares/{_id}/dismiss` instead. To
160
+ remove a user from *your* account, use `DELETE /v1/ashares/{_id}`.
161
+ parameters:
162
+ - name: _id
163
+ in: path
164
+ required: true
165
+ description: Share record id from `GET /v1/shared/ashares`, not a user or account id.
166
+ schema:
167
+ type: string
168
+ format: objectId
169
+ examples:
170
+ - 612345abcdef6789012345ab
171
+ responses:
172
+ '204':
173
+ description: Share record removed; the caller no longer has access to the account.
174
+ '401':
175
+ $ref: '#/components/responses/401-unauthorized'
176
+ '404':
177
+ description: No share with this id is addressed to the caller.
178
+ content:
179
+ application/json:
180
+ schema:
181
+ $ref: '#/components/schemas/Error'
182
+ examples:
183
+ notShared:
184
+ value:
185
+ errors:
186
+ - code: invalid_ashare
187
+ message: The account you are trying to access is not shared with you.
145
188
  /v1/shared/sshares:
146
189
  get:
147
190
  x-internal: false
@@ -152,7 +195,9 @@ paths:
152
195
  description: |-
153
196
  Returns stack-share records for the current user, including share
154
197
  status, the user who shared, and a stack summary. To list usable
155
- stacks directly, use `GET /v1/shared/stacks`.
198
+ stacks directly, use `GET /v1/shared/stacks`. Respond to a pending
199
+ invitation with `PUT /v1/sshares/{_id}/accept` or
200
+ `PUT /v1/sshares/{_id}/dismiss`.
156
201
  responses:
157
202
  '200':
158
203
  description: Array of stack share entries.
@@ -179,6 +224,90 @@ paths:
179
224
  description: No stacks are shared with the current user.
180
225
  '401':
181
226
  $ref: '#/components/responses/401-unauthorized'
227
+ /v1/sshares/{_id}/accept:
228
+ put:
229
+ x-internal: false
230
+ operationId: acceptStackShareInvitation
231
+ tags:
232
+ - Account
233
+ summary: Accept a stack share invitation
234
+ description: |-
235
+ Accepts an invitation to use another user's stack on behalf of the caller.
236
+ The `_id` is a share record addressed *to* the caller — take it from
237
+ `GET /v1/shared/sshares`. Once accepted, the stack appears in
238
+ `GET /v1/shared/stacks` and can be referenced by the caller's hooks and
239
+ wrappers. Accepting a share that is already accepted changes nothing.
240
+ x-celigo-ai-guidance:
241
+ - Recipient-side operation. To share one of your own stacks, use `POST /v1/stacks/{_id}/invite` (Stacks API).
242
+ parameters:
243
+ - name: _id
244
+ in: path
245
+ required: true
246
+ description: Share record id from `GET /v1/shared/sshares`, not the stack id.
247
+ schema:
248
+ type: string
249
+ format: objectId
250
+ examples:
251
+ - 69f53622861a268851c836d0
252
+ responses:
253
+ '204':
254
+ description: Invitation accepted (or already accepted).
255
+ '401':
256
+ $ref: '#/components/responses/401-unauthorized'
257
+ '404':
258
+ description: No stack share with this id is addressed to the caller.
259
+ content:
260
+ application/json:
261
+ schema:
262
+ $ref: '#/components/schemas/Error'
263
+ examples:
264
+ notShared:
265
+ value:
266
+ errors:
267
+ - code: invalid_ref
268
+ message: SShare not found.
269
+ /v1/sshares/{_id}/dismiss:
270
+ put:
271
+ x-internal: false
272
+ operationId: dismissStackShareInvitation
273
+ tags:
274
+ - Account
275
+ summary: Dismiss a stack share invitation
276
+ description: |-
277
+ Declines an invitation to use another user's stack on behalf of the caller.
278
+ The `_id` is a share record addressed *to* the caller — take it from
279
+ `GET /v1/shared/sshares`. The owner can send the invitation again with
280
+ `PUT /v1/sshares/{_id}/reinvite`. Dismissing a share that is already
281
+ dismissed changes nothing.
282
+ x-celigo-ai-guidance:
283
+ - Recipient-side operation. As the stack owner, revoke a share with `DELETE /v1/sshares/{_id}` (Stacks API) instead.
284
+ parameters:
285
+ - name: _id
286
+ in: path
287
+ required: true
288
+ description: Share record id from `GET /v1/shared/sshares`, not the stack id.
289
+ schema:
290
+ type: string
291
+ format: objectId
292
+ examples:
293
+ - 69f53622861a268851c836d0
294
+ responses:
295
+ '204':
296
+ description: Invitation dismissed (or already dismissed).
297
+ '401':
298
+ $ref: '#/components/responses/401-unauthorized'
299
+ '404':
300
+ description: No stack share with this id is addressed to the caller.
301
+ content:
302
+ application/json:
303
+ schema:
304
+ $ref: '#/components/schemas/Error'
305
+ examples:
306
+ notShared:
307
+ value:
308
+ errors:
309
+ - code: invalid_ref
310
+ message: SShare not found.
182
311
  /v1/shared/stacks:
183
312
  get:
184
313
  x-internal: false
@@ -317,7 +446,34 @@ components:
317
446
  type: boolean
318
447
  description: |-
319
448
  When true, the current user has accepted the invitation.
320
- Unaccepted shares appear in the list but cannot be acted on.
449
+ Unaccepted shares appear in the list but cannot be acted on —
450
+ accept one with `PUT /v1/ashares/{_id}/accept`.
451
+ dismissed:
452
+ type: boolean
453
+ description: |-
454
+ When true, the current user declined the invitation. Present only while
455
+ dismissed; the owner can reinvite, which clears it.
456
+ disabled:
457
+ type: boolean
458
+ description: |-
459
+ When true, the owner has suspended the current user's access to the
460
+ account. Present only while suspended.
461
+ accountSSORequired:
462
+ type: boolean
463
+ description: |-
464
+ When true, the owner requires the current user to sign in through SSO
465
+ for this account. Present only when the owner has an active SSO client;
466
+ reads true while the owner enforces SSO for every user, even if the
467
+ share itself does not carry the flag.
468
+ ssoSetupPending:
469
+ type: boolean
470
+ description: |-
471
+ When true, the current user has not yet completed SSO setup with this
472
+ owner, so the SSO-required access is not fully active. Present only
473
+ while pending.
474
+ isProductionAdmin:
475
+ type: boolean
476
+ description: When true, the share grants administrator access to the owner's production environment. Present only when it applies.
321
477
  accessLevel:
322
478
  type: string
323
479
  description: |-
@@ -330,10 +486,12 @@ components:
330
486
  - administrator
331
487
  - manage
332
488
  - monitor
489
+ - none
333
490
  x-enumDescriptions:
334
491
  administrator: Full administration including user management and account settings
335
492
  manage: Create and edit integrations and resources, but not account settings or users
336
493
  monitor: Read-only view of integrations, flows, and errors
494
+ none: No account-wide access; recorded by SCIM provisioning when access comes only from integrationAccessLevel
337
495
  integrationAccessLevel:
338
496
  type: array
339
497
  description: |-
@@ -396,6 +554,46 @@ components:
396
554
  examples:
397
555
  - '2025-11-15T12:00:00.000Z'
398
556
  description: Timestamp when this share record was created.
557
+ Error:
558
+ type: object
559
+ description: Standard error response envelope returned by integrator.io APIs.
560
+ properties:
561
+ errors:
562
+ type: array
563
+ description: List of errors that occurred while processing the request.
564
+ items:
565
+ type: object
566
+ properties:
567
+ code:
568
+ oneOf:
569
+ - type: string
570
+ - type: integer
571
+ description: |-
572
+ Machine-readable error code. Usually a string like
573
+ `invalid_ref`, `missing_required_field`, or `unauthorized`;
574
+ may be an **integer** when the error mirrors an upstream HTTP
575
+ status (e.g. `500`) — most commonly returned by connection-ping
576
+ and adaptor-proxy responses.
577
+ message:
578
+ type: string
579
+ description: Human-readable description of the error.
580
+ field:
581
+ type: string
582
+ description: |-
583
+ Optional pointer to the document field that caused the error.
584
+ Used by structural validation errors (`missing_required_field`,
585
+ `invalid_ref`) to indicate which field is at fault
586
+ (e.g. `_id`, `type`, `http.baseURI`).
587
+ source:
588
+ type: string
589
+ description: |-
590
+ Optional origin layer for the error — e.g. `application` when
591
+ the error came from the remote system the adaptor called,
592
+ `connector` when the adaptor itself rejected the request.
593
+ required:
594
+ - message
595
+ required:
596
+ - errors
399
597
  StackShare:
400
598
  type: object
401
599
  description: |-
package/dist/agent.yml CHANGED
@@ -754,6 +754,13 @@ components:
754
754
  description: Display name of the dependent resource.
755
755
  examples:
756
756
  - Import Orders to NetSuite
757
+ type:
758
+ type: string
759
+ description: |-
760
+ Sub-type of the dependent resource when its collection distinguishes one, such as
761
+ `stream` for a listener export. Only present for resource types that carry a `type`.
762
+ examples:
763
+ - stream
757
764
  paths:
758
765
  type: array
759
766
  description: |-
package/dist/ai-agent.yml CHANGED
@@ -94,6 +94,16 @@ paths:
94
94
  format:
95
95
  type: json_schema
96
96
  name: agent-response
97
+ strict: false
98
+ jsonSchema:
99
+ type: object
100
+ properties:
101
+ action:
102
+ type: string
103
+ draftBody:
104
+ type: string
105
+ required:
106
+ - action
97
107
  verbose: medium
98
108
  tools:
99
109
  - type: mcp
@@ -260,6 +270,16 @@ paths:
260
270
  format:
261
271
  type: json_schema
262
272
  name: agent-response
273
+ strict: false
274
+ jsonSchema:
275
+ type: object
276
+ properties:
277
+ action:
278
+ type: string
279
+ draftBody:
280
+ type: string
281
+ required:
282
+ - action
263
283
  verbose: medium
264
284
  tools:
265
285
  - type: mcp
@@ -941,18 +961,21 @@ components:
941
961
  - medium
942
962
  - high
943
963
  - xhigh
964
+ - max
944
965
  x-enumDescriptions:
945
966
  none: No additional reasoning effort.
946
967
  minimal: Least reasoning effort for simple, straightforward tasks.
947
968
  low: Light reasoning for moderately simple tasks.
948
969
  medium: Balanced reasoning effort for typical tasks.
949
- high: Maximum reasoning effort for complex, multi-step tasks.
950
- xhigh: Highest reasoning effort for the most demanding, multi-step tasks.
970
+ high: Heavy reasoning effort for complex, multi-step tasks.
971
+ xhigh: Very high reasoning effort for the most demanding, multi-step tasks.
972
+ max: Highest available reasoning effort, above xhigh.
951
973
  description: How much reasoning effort the model should invest
952
974
  x-celigo-ai-guidance:
953
975
  - |-
954
976
  How much reasoning effort the model should invest.
955
977
  Reasoning- capable models only — see `reasoning` for the gating rule.
978
+ - Any other value fails the save with 422 `enum` on `aiAgent.openai.reasoning.effort`.
956
979
  summary:
957
980
  type: string
958
981
  enum:
@@ -1088,6 +1111,13 @@ components:
1088
1111
  additionalproperties:
1089
1112
  type: boolean
1090
1113
  description: When true, the structured output may include properties beyond those defined in `properties`.
1114
+ schema:
1115
+ type: object
1116
+ readOnly: true
1117
+ additionalProperties: true
1118
+ description: |-
1119
+ Server-written copy of `jsonSchema`, returned whenever `jsonSchema` is set — on
1120
+ AI agent imports and on guardrail agents alike. Send `jsonSchema`, not this field.
1091
1121
  if:
1092
1122
  properties:
1093
1123
  type:
@@ -1130,13 +1160,19 @@ components:
1130
1160
  - web_search
1131
1161
  - mcp
1132
1162
  - image_generation
1163
+ - code_execution
1133
1164
  - tool
1134
1165
  x-enumDescriptions:
1135
1166
  web_search: Search the web for real-time information.
1136
1167
  mcp: Connect to an MCP server for additional external tools.
1137
1168
  image_generation: Generate images using an AI image model.
1169
+ code_execution: 'Enable OpenAI''s built-in code-execution tool; carries no configuration block, send `{type: code_execution}` only'
1138
1170
  tool: Reference a reusable Celigo Tool resource.
1139
- description: Type of tool.
1171
+ description: |-
1172
+ Type of tool. Every type except `code_execution` is configured through the
1173
+ sibling object of the same name; OpenAI spells this one `code_execution`, while
1174
+ the Gemini and Anthropic overrides spell theirs `codeExecution` — the other spelling
1175
+ fails with 422 `enum`.
1140
1176
  webSearch:
1141
1177
  type: object
1142
1178
  description: Web search configuration (empty object to enable)
@@ -1470,15 +1506,19 @@ components:
1470
1506
  - googleSearch
1471
1507
  - urlContext
1472
1508
  - fileSearch
1509
+ - codeExecution
1473
1510
  - mcp
1474
1511
  - tool
1475
1512
  x-enumDescriptions:
1476
1513
  googleSearch: Use Google Search for real-time information grounding.
1477
1514
  urlContext: Retrieve and use content from specified URLs.
1478
1515
  fileSearch: Search through previously uploaded files.
1516
+ codeExecution: 'Enable Gemini''s built-in code-execution tool; carries no configuration block, send `{type: codeExecution}` only'
1479
1517
  mcp: Connect to an MCP server for additional external tools.
1480
1518
  tool: Reference a reusable Celigo Tool resource.
1481
- description: Type of Gemini tool.
1519
+ description: |-
1520
+ Type of Gemini tool. `codeExecution` is the Gemini spelling — `code_execution`
1521
+ fails with 422 `enum`.
1482
1522
  googleSearch:
1483
1523
  type: object
1484
1524
  description: Google Search configuration (empty object to enable)
@@ -1810,11 +1850,15 @@ components:
1810
1850
  - tool
1811
1851
  - mcp
1812
1852
  - webSearch
1853
+ - codeExecution
1813
1854
  x-enumDescriptions:
1814
1855
  tool: Reference a reusable Celigo Tool resource.
1815
1856
  mcp: Connect to an MCP server for additional external tools.
1816
1857
  webSearch: Search the web for real-time information.
1817
- description: Type of Claude tool.
1858
+ codeExecution: 'Enable Anthropic''s built-in code-execution tool; carries no configuration block, send `{type: codeExecution}` only'
1859
+ description: |-
1860
+ Type of Claude tool. `codeExecution` is the Anthropic spelling — `code_execution`
1861
+ fails with 422 `enum`.
1818
1862
  tool:
1819
1863
  type: object
1820
1864
  description: Reference to a Celigo Tool resource, used when type is "tool".
@@ -1862,9 +1906,43 @@ components:
1862
1906
  description: Connection to the MCP server.
1863
1907
  allowedTools:
1864
1908
  type: array
1865
- description: Specific tools to allow from the MCP server (all if omitted).
1909
+ description: |-
1910
+ Specific tools to allow from the MCP server (all if omitted). Each
1911
+ entry is either a plain tool name or an object carrying display
1912
+ metadata — same contract as the OpenAI and Gemini `allowedTools`.
1866
1913
  items:
1867
- type: string
1914
+ oneOf:
1915
+ - title: name
1916
+ type: string
1917
+ description: Tool name as exposed by the MCP server.
1918
+ - title: tool
1919
+ type: object
1920
+ required:
1921
+ - name
1922
+ properties:
1923
+ name:
1924
+ type: string
1925
+ maxLength: 256
1926
+ description: Tool name as exposed by the MCP server.
1927
+ title:
1928
+ type: string
1929
+ maxLength: 300
1930
+ description: Display title shown for the tool.
1931
+ description:
1932
+ type: string
1933
+ maxLength: 1000
1934
+ description: Display description shown for the tool.
1935
+ x-celigo-ai-guidance:
1936
+ - |-
1937
+ Object entries accept only name/title/description — any other key
1938
+ fails the save with 422 `invalid_field_value` ("unknown field(s): …"),
1939
+ and an object without `name` fails with 422 `missing_required_field`
1940
+ ("Expected field: name to be present.").
1941
+ examples:
1942
+ - - hub_repo_search
1943
+ - name: hub_repo_info
1944
+ title: Repository info
1945
+ description: Look up a repository by name
1868
1946
  webSearch:
1869
1947
  type: object
1870
1948
  description: Web search configuration, used when type is "webSearch".
@@ -5251,9 +5329,6 @@ components:
5251
5329
  ignoreMissing:
5252
5330
  type: boolean
5253
5331
  description: When true, records that do not already exist in the destination are silently skipped. Rarely meaningful for AI agents; accepted for import-surface parity.
5254
- blob:
5255
- type: boolean
5256
- description: When true, the agent processes raw file content (blobs) rather than structured records.
5257
5332
  mockResponse:
5258
5333
  type: array
5259
5334
  description: |-
@@ -5291,9 +5366,6 @@ components:
5291
5366
  _headers:
5292
5367
  type: object
5293
5368
  description: Mock response headers.
5294
- blobKey:
5295
- type: string
5296
- description: Blob key returned by blob-mode agents.
5297
5369
  ResourceResponse:
5298
5370
  type: object
5299
5371
  description: Response
@@ -5508,6 +5580,11 @@ components:
5508
5580
  flat format (`aiAgent.model`, `aiAgent.modelOptions`, …) for the catalog
5509
5581
  providers. Omit `_connectionId` to use platform-managed credentials on a
5510
5582
  built-in provider; catalog providers need a BYOK connection to run.
5583
+ x-celigo-ai-guidance:
5584
+ - |-
5585
+ AI agents process structured records only. Do not send the import-level `blob` or
5586
+ `blobKeyPath` fields — either one fails the save with 422 `not_supported`
5587
+ ("Field "blob" is not supported for this import type").
5511
5588
  required:
5512
5589
  - name
5513
5590
  - adaptorType
@@ -5725,6 +5802,13 @@ components:
5725
5802
  description: Display name of the dependent resource.
5726
5803
  examples:
5727
5804
  - Import Orders to NetSuite
5805
+ type:
5806
+ type: string
5807
+ description: |-
5808
+ Sub-type of the dependent resource when its collection distinguishes one, such as
5809
+ `stream` for a listener export. Only present for resource types that carry a `type`.
5810
+ examples:
5811
+ - stream
5728
5812
  paths:
5729
5813
  type: array
5730
5814
  description: |-