@zapier/zapier-sdk-core 0.4.0 → 0.5.1
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/CHANGELOG.md +13 -0
- package/dist/index.cjs +30 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.js +30 -1
- package/dist/index.js.map +1 -1
- package/dist/v0/config/metadata.cjs +4 -0
- package/dist/v0/config/metadata.cjs.map +1 -1
- package/dist/v0/config/metadata.js +4 -0
- package/dist/v0/config/metadata.js.map +1 -1
- package/dist/v0/schemas/actions.cjs +90 -0
- package/dist/v0/schemas/actions.cjs.map +1 -0
- package/dist/v0/schemas/actions.d.cts +151 -0
- package/dist/v0/schemas/actions.d.ts +151 -0
- package/dist/v0/schemas/actions.js +61 -0
- package/dist/v0/schemas/actions.js.map +1 -0
- package/dist/v0/schemas/authentications.cjs +36 -3
- package/dist/v0/schemas/authentications.cjs.map +1 -1
- package/dist/v0/schemas/authentications.d.cts +59 -2
- package/dist/v0/schemas/authentications.d.ts +59 -2
- package/dist/v0/schemas/authentications.js +33 -2
- package/dist/v0/schemas/authentications.js.map +1 -1
- package/openapi.yaml +126 -2
- package/package.json +6 -1
package/openapi.yaml
CHANGED
|
@@ -11,6 +11,8 @@ info:
|
|
|
11
11
|
description: The Zapier SDK API serves as a backend for the Zapier SDK.
|
|
12
12
|
servers: []
|
|
13
13
|
tags:
|
|
14
|
+
- name: Actions
|
|
15
|
+
description: Action-related routes
|
|
14
16
|
- name: Apps
|
|
15
17
|
description: App-related routes
|
|
16
18
|
- name: Authentications
|
|
@@ -284,6 +286,66 @@ components:
|
|
|
284
286
|
$ref: "#/components/schemas/AuthenticationItem"
|
|
285
287
|
required:
|
|
286
288
|
- data
|
|
289
|
+
ListActionsResponse:
|
|
290
|
+
type: object
|
|
291
|
+
properties:
|
|
292
|
+
data:
|
|
293
|
+
type: array
|
|
294
|
+
items:
|
|
295
|
+
type: object
|
|
296
|
+
properties:
|
|
297
|
+
id:
|
|
298
|
+
type: string
|
|
299
|
+
description: Unique identifier for the action
|
|
300
|
+
key:
|
|
301
|
+
type: string
|
|
302
|
+
description: Unique key identifier for the action
|
|
303
|
+
description:
|
|
304
|
+
type: string
|
|
305
|
+
description: Description of what the action does
|
|
306
|
+
is_important:
|
|
307
|
+
type: boolean
|
|
308
|
+
description: Whether this action is marked as important
|
|
309
|
+
is_hidden:
|
|
310
|
+
type: boolean
|
|
311
|
+
description: Whether this action is hidden from listings
|
|
312
|
+
app_key:
|
|
313
|
+
type: string
|
|
314
|
+
description: App key extracted from implementation ID (without version)
|
|
315
|
+
app_version:
|
|
316
|
+
type: string
|
|
317
|
+
description: App version extracted from implementation ID
|
|
318
|
+
action_type:
|
|
319
|
+
type: string
|
|
320
|
+
enum:
|
|
321
|
+
- filter
|
|
322
|
+
- read
|
|
323
|
+
- read_bulk
|
|
324
|
+
- run
|
|
325
|
+
- search
|
|
326
|
+
- search_and_write
|
|
327
|
+
- search_or_write
|
|
328
|
+
- write
|
|
329
|
+
description: The type of action
|
|
330
|
+
title:
|
|
331
|
+
type: string
|
|
332
|
+
description: Display name of the action (mapped from name)
|
|
333
|
+
type:
|
|
334
|
+
type: string
|
|
335
|
+
enum:
|
|
336
|
+
- action
|
|
337
|
+
description: Type identifier for this item
|
|
338
|
+
required:
|
|
339
|
+
- key
|
|
340
|
+
- description
|
|
341
|
+
- app_key
|
|
342
|
+
- action_type
|
|
343
|
+
- title
|
|
344
|
+
- type
|
|
345
|
+
description: Normalized action item returned by list actions endpoint
|
|
346
|
+
description: Array of action items
|
|
347
|
+
required:
|
|
348
|
+
- data
|
|
287
349
|
ListAuthenticationsResponse:
|
|
288
350
|
type: object
|
|
289
351
|
properties:
|
|
@@ -420,6 +482,7 @@ components:
|
|
|
420
482
|
- data
|
|
421
483
|
- links
|
|
422
484
|
- meta
|
|
485
|
+
description: Response schema for listing authentications
|
|
423
486
|
parameters: {}
|
|
424
487
|
securitySchemes:
|
|
425
488
|
userJwt:
|
|
@@ -507,8 +570,7 @@ paths:
|
|
|
507
570
|
- userJwt: []
|
|
508
571
|
parameters:
|
|
509
572
|
- schema:
|
|
510
|
-
type:
|
|
511
|
-
exclusiveMinimum: 0
|
|
573
|
+
type: string
|
|
512
574
|
description: Authentication ID to retrieve
|
|
513
575
|
required: true
|
|
514
576
|
description: Authentication ID to retrieve
|
|
@@ -543,6 +605,68 @@ paths:
|
|
|
543
605
|
headers: *a6
|
|
544
606
|
content:
|
|
545
607
|
application/json: *a7
|
|
608
|
+
/api/v0/actions:
|
|
609
|
+
get:
|
|
610
|
+
summary: List actions
|
|
611
|
+
description: Returns a list of actions for a specific app with optional filtering by action type.
|
|
612
|
+
tags:
|
|
613
|
+
- Actions
|
|
614
|
+
operationId: v0_list_actions
|
|
615
|
+
security:
|
|
616
|
+
- userJwt: []
|
|
617
|
+
parameters:
|
|
618
|
+
- schema:
|
|
619
|
+
type: string
|
|
620
|
+
description: App key to list actions for (e.g., 'SlackCLIAPI@1.21.1' or 'SlackCLIAPI')
|
|
621
|
+
required: true
|
|
622
|
+
description: App key to list actions for (e.g., 'SlackCLIAPI@1.21.1' or 'SlackCLIAPI')
|
|
623
|
+
name: appKey
|
|
624
|
+
in: query
|
|
625
|
+
- schema:
|
|
626
|
+
type: string
|
|
627
|
+
enum:
|
|
628
|
+
- filter
|
|
629
|
+
- read
|
|
630
|
+
- read_bulk
|
|
631
|
+
- run
|
|
632
|
+
- search
|
|
633
|
+
- search_and_write
|
|
634
|
+
- search_or_write
|
|
635
|
+
- write
|
|
636
|
+
description: Filter actions by type (e.g., 'read', 'write', 'search')
|
|
637
|
+
required: false
|
|
638
|
+
description: Filter actions by type (e.g., 'read', 'write', 'search')
|
|
639
|
+
name: actionType
|
|
640
|
+
in: query
|
|
641
|
+
responses:
|
|
642
|
+
"200":
|
|
643
|
+
description: Successfully retrieved actions list
|
|
644
|
+
content:
|
|
645
|
+
application/json:
|
|
646
|
+
schema:
|
|
647
|
+
$ref: "#/components/schemas/ListActionsResponse"
|
|
648
|
+
"400":
|
|
649
|
+
description: Bad Request
|
|
650
|
+
content:
|
|
651
|
+
application/json: *a1
|
|
652
|
+
"401":
|
|
653
|
+
description: Unauthorized
|
|
654
|
+
content:
|
|
655
|
+
application/json: *a2
|
|
656
|
+
"429":
|
|
657
|
+
description: Too Many Requests
|
|
658
|
+
headers: *a3
|
|
659
|
+
content:
|
|
660
|
+
application/json: *a4
|
|
661
|
+
"500":
|
|
662
|
+
description: Server Error
|
|
663
|
+
content:
|
|
664
|
+
application/json: *a5
|
|
665
|
+
"503":
|
|
666
|
+
description: Service Unavailable
|
|
667
|
+
headers: *a6
|
|
668
|
+
content:
|
|
669
|
+
application/json: *a7
|
|
546
670
|
/api/v0/apps:
|
|
547
671
|
get:
|
|
548
672
|
summary: List apps
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@zapier/zapier-sdk-core",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.5.1",
|
|
4
4
|
"description": "Core schemas and TypeScript types for the Zapier SDK API",
|
|
5
5
|
"license": "SEE LICENSE IN LICENSE",
|
|
6
6
|
"author": "Zapier, Inc.",
|
|
@@ -46,6 +46,11 @@
|
|
|
46
46
|
"import": "./dist/v0/schemas/errors.js",
|
|
47
47
|
"require": "./dist/v0/schemas/errors.cjs"
|
|
48
48
|
},
|
|
49
|
+
"./v0/schemas/actions": {
|
|
50
|
+
"types": "./dist/v0/schemas/actions.d.ts",
|
|
51
|
+
"import": "./dist/v0/schemas/actions.js",
|
|
52
|
+
"require": "./dist/v0/schemas/actions.cjs"
|
|
53
|
+
},
|
|
49
54
|
"./v0/common/responses": {
|
|
50
55
|
"types": "./dist/v0/common/responses.d.ts",
|
|
51
56
|
"import": "./dist/v0/common/responses.js",
|