@zapier/zapier-sdk-core 0.2.0 → 0.4.0

package/openapi.yaml

@@ -11,6 +11,8 @@ info:
   description: The Zapier SDK API serves as a backend for the Zapier SDK.
 servers: []
 tags:
+  - name: Apps
+    description: App-related routes
   - name: Authentications
     description: Authentication-related routes
   - name: Documentation
@@ -151,7 +153,7 @@ components:
       type: object
       properties:
         id:
-          type: number
+          type: string
           description: Unique identifier for the authentication
         date:
           type: string
@@ -160,7 +162,7 @@ components:
           type: string
           description: Date last changed
         account_id:
-          type: number
+          type: string
           description: Account ID associated with this authentication
         destination_selected_api:
           type:
@@ -224,7 +226,7 @@ components:
           type: string
           description: Implementation ID (was selected_api)
         profile_id:
-          type: number
+          type: string
           description: Profile ID (was customuser_id)
         is_expired:
           type: string
@@ -249,10 +251,10 @@ components:
         - shared_with_all
       description: Normalized authentication item returned by getAuthentication handler
       example:
-        id: 12345
+        id: "12345"
         date: 2023-01-15T10:30:00Z
         lastchanged: 2023-06-20T14:45:00Z
-        account_id: 98765
+        account_id: "98765"
         destination_selected_api: null
         is_invite_only: false
         is_private: true
@@ -270,7 +272,7 @@ components:
           can_view: true
           can_delete: true
         implementation_id: SlackCLIAPI@1.0.0
-        profile_id: 54321
+        profile_id: "54321"
         is_expired: "false"
         expired_at: null
         app_key: SlackCLIAPI
@@ -291,7 +293,7 @@ components:
             type: object
             properties:
               id:
-                type: number
+                type: string
                 description: Unique identifier for the authentication
               date:
                 type: string
@@ -300,7 +302,7 @@ components:
                 type: string
                 description: Date last changed
               account_id:
-                type: number
+                type: string
                 description: Account ID associated with this authentication
               destination_selected_api:
                 type:
@@ -364,7 +366,7 @@ components:
                 type: string
                 description: Implementation ID (was selected_api)
               profile_id:
-                type: number
+                type: string
                 description: Profile ID (was customuser_id)
               is_expired:
                 type: string
@@ -541,6 +543,271 @@ paths:
           headers: *a6
           content:
             application/json: *a7
+  /api/v0/apps:
+    get:
+      summary: List apps
+      description: Returns a paginated list of apps with optional filtering by app keys or search term.
+      tags:
+        - Apps
+      operationId: v0_list_apps
+      security:
+        - userJwt: []
+      parameters:
+        - schema:
+            type: string
+            description: Comma-separated list of app keys to filter by (e.g., 'SlackCLIAPI' or slugs like 'github,slack')
+          required: false
+          description: Comma-separated list of app keys to filter by (e.g., 'SlackCLIAPI' or slugs like 'github,slack')
+          name: appKeys
+          in: query
+        - schema:
+            type: string
+            description: Search term to filter apps by name
+          required: false
+          description: Search term to filter apps by name
+          name: search
+          in: query
+        - schema:
+            type: integer
+            minimum: 1
+            maximum: 100
+            default: 20
+            description: Number of apps per page (1-100)
+          required: false
+          description: Number of apps per page (1-100)
+          name: pageSize
+          in: query
+        - schema:
+            type: string
+            description: Pagination offset from previous response
+          required: false
+          description: Pagination offset from previous response
+          name: offset
+          in: query
+      responses:
+        "200":
+          description: Successfully retrieved apps list
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  data:
+                    type: array
+                    items:
+                      type: object
+                      properties:
+                        slug:
+                          type: string
+                          description: URL-friendly slug identifier
+                        age_in_days:
+                          type: number
+                          description: Number of days since the implementation was created
+                        auth_type:
+                          type: string
+                          description: Authentication type (e.g., oauth2, api_key)
+                        banner:
+                          type: string
+                          description: Banner message or status indicator
+                        categories:
+                          type: array
+                          items:
+                            type: object
+                            properties:
+                              id:
+                                type: number
+                                description: Unique identifier for the category
+                              name:
+                                type: string
+                                description: Display name of the category
+                              slug:
+                                type: string
+                                description: URL-friendly slug for the category
+                            required:
+                              - id
+                              - name
+                              - slug
+                          description: Categories the implementation belongs to
+                        images:
+                          type: object
+                          properties:
+                            url_16x16:
+                              type: string
+                              description: 16x16 pixel icon URL
+                            url_32x32:
+                              type: string
+                              description: 32x32 pixel icon URL
+                            url_64x64:
+                              type: string
+                              description: 64x64 pixel icon URL
+                            url_128x128:
+                              type: string
+                              description: 128x128 pixel icon URL
+                          description: Icon images at various sizes
+                        popularity:
+                          type: number
+                          description: Popularity score for ranking apps
+                        has_filters:
+                          type: boolean
+                          description: Whether the app has filter actions
+                        has_reads:
+                          type: boolean
+                          description: Whether the app has read actions
+                        has_searches:
+                          type: boolean
+                          description: Whether the app has search actions
+                        has_searches_or_writes:
+                          type: boolean
+                          description: Whether the app has search or write actions
+                        has_upfront_fields:
+                          type: boolean
+                          description: Whether the app has upfront input fields
+                        has_writes:
+                          type: boolean
+                          description: Whether the app has write actions
+                        is_beta:
+                          type: boolean
+                          description: Whether the app is in beta
+                        is_built_in:
+                          type: boolean
+                          description: Whether the app is a built-in Zapier app
+                        is_deprecated:
+                          type: boolean
+                          description: Whether the app is deprecated
+                        is_featured:
+                          type: boolean
+                          description: Whether the app is featured
+                        is_hidden:
+                          type: boolean
+                          description: Whether the app is hidden from listings
+                        is_invite:
+                          type: boolean
+                          description: Whether the app is invite-only
+                        is_premium:
+                          type: boolean
+                          description: Whether the app requires a premium plan
+                        is_public:
+                          type: boolean
+                          description: Whether the app is publicly available
+                        is_upcoming:
+                          type: boolean
+                          description: Whether the app is upcoming/not yet released
+                        version:
+                          type: string
+                          description: App version
+                        visibility:
+                          type: string
+                          description: Visibility status (e.g., public, private)
+                        actions:
+                          type: object
+                          properties:
+                            read:
+                              type: number
+                              description: Number of read actions
+                            read_bulk:
+                              type: number
+                              description: Number of bulk read actions
+                            write:
+                              type: number
+                              description: Number of write actions
+                            search:
+                              type: number
+                              description: Number of search actions
+                            search_or_write:
+                              type: number
+                              description: Number of search-or-write actions
+                            search_and_write:
+                              type: number
+                              description: Number of search-and-write actions
+                            filter:
+                              type: number
+                              description: Number of filter actions
+                          description: Count of available actions by type
+                        description:
+                          type: string
+                          description: Description of the app
+                        primary_color:
+                          type: string
+                          description: Primary brand color (hex)
+                        secondary_color:
+                          type: string
+                          description: Secondary brand color (hex)
+                        classification:
+                          type: string
+                          description: App classification category
+                        api_docs_url:
+                          type: string
+                          description: URL to API documentation
+                        image:
+                          type: string
+                          description: Default image URL for the app
+                        title:
+                          type: string
+                          description: Display name of the app
+                        key:
+                          type: string
+                          description: App key (versionless implementation name)
+                        implementation_id:
+                          type: string
+                          description: Full implementation ID including version
+                      required:
+                        - slug
+                        - title
+                        - key
+                        - implementation_id
+                    description: Array of app items
+                  links:
+                    type: object
+                    properties:
+                      next:
+                        type:
+                          - string
+                          - "null"
+                        description: Fully qualified URL for the next page of results (if available)
+                    description: Pagination links for navigating through results
+                  meta:
+                    type: object
+                    properties:
+                      count:
+                        type: number
+                        description: Number of items in current page
+                      limit:
+                        type: number
+                        description: Number of items per page
+                      offset:
+                        type: number
+                        description: Offset of the current page
+                    required:
+                      - count
+                      - limit
+                      - offset
+                    description: Metadata for the paginated result set
+                required:
+                  - data
+                  - links
+                  - meta
+        "400":
+          description: Bad Request
+          content:
+            application/json: *a1
+        "401":
+          description: Unauthorized
+          content:
+            application/json: *a2
+        "429":
+          description: Too Many Requests
+          headers: *a3
+          content:
+            application/json: *a4
+        "500":
+          description: Server Error
+          content:
+            application/json: *a5
+        "503":
+          description: Service Unavailable
+          headers: *a6
+          content:
+            application/json: *a7
   /api/v0/authentications:
     get:
       summary: List authentications

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zapier/zapier-sdk-core",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "Core schemas and TypeScript types for the Zapier SDK API",
   "license": "SEE LICENSE IN LICENSE",
   "author": "Zapier, Inc.",
@@ -31,6 +31,16 @@
       "import": "./dist/v0/schemas/authentications.js",
       "require": "./dist/v0/schemas/authentications.cjs"
     },
+    "./v0/schemas/apps": {
+      "types": "./dist/v0/schemas/apps.d.ts",
+      "import": "./dist/v0/schemas/apps.js",
+      "require": "./dist/v0/schemas/apps.cjs"
+    },
+    "./v0/schemas/implementations": {
+      "types": "./dist/v0/schemas/implementations.d.ts",
+      "import": "./dist/v0/schemas/implementations.js",
+      "require": "./dist/v0/schemas/implementations.cjs"
+    },
     "./v0/schemas/errors": {
       "types": "./dist/v0/schemas/errors.d.ts",
       "import": "./dist/v0/schemas/errors.js",