@zapier/zapier-sdk-core 0.7.1 → 0.8.0

package/openapi.yaml

@@ -16,9 +16,11 @@ tags:
   - name: Apps
     description: App-related routes
   - name: Authentications
-    description: Authentication-related routes
+    description: Authentication-related routes (deprecated, use Connections)
   - name: Client Credentials
     description: Client credentials management routes
+  - name: Connections
+    description: Connection-related routes
   - name: Deduplication
     description: Deduplication-related routes
   - name: Documentation
@@ -378,6 +380,141 @@ components:
           $ref: "#/components/schemas/AuthenticationItem"
       required:
         - data
+    ConnectionItem:
+      type: object
+      properties:
+        id:
+          type: string
+          description: Unique identifier for the connection
+        date:
+          type: string
+          description: Date created
+        lastchanged:
+          type: string
+          description: Date last changed
+        account_id:
+          type: string
+          description: Account ID associated with this connection
+        destination_selected_api:
+          type:
+            - string
+            - "null"
+          description: Destination API key (if applicable)
+        is_invite_only:
+          type: boolean
+          description: Whether the connection is invite-only
+        is_private:
+          type: boolean
+          description: Whether the connection is private
+        shared_with_all:
+          type: boolean
+          description: Whether the connection is shared with all users
+        is_stale:
+          type: string
+          description: Stale status string
+        is_shared:
+          type: string
+          description: Shared status string
+        marked_stale_at:
+          type:
+            - string
+            - "null"
+          description: Date when marked stale
+        label:
+          type:
+            - string
+            - "null"
+          description: User label for the connection
+        identifier:
+          type:
+            - string
+            - "null"
+          description: Identifier
+        title:
+          type:
+            - string
+            - "null"
+          description: Title of the connection
+        url:
+          type: string
+          description: URL to the connection resource
+        groups:
+          type: array
+          items:
+            type: object
+            additionalProperties: {}
+            description: Groups associated with the connection
+          description: Array of groups associated with the connection
+        members:
+          type: string
+          description: Members associated with the connection
+        permissions:
+          type: object
+          additionalProperties:
+            type: boolean
+          description: Permissions for the connection
+        implementation_id:
+          type: string
+          description: Implementation ID (was selected_api)
+        profile_id:
+          type: string
+          description: Profile ID (was customuser_id)
+        is_expired:
+          type: string
+          description: Whether the connection is expired (mapped from is_stale)
+        expired_at:
+          type:
+            - string
+            - "null"
+          description: Date when connection expired (mapped from marked_stale_at)
+        app_key:
+          type: string
+          description: App Key extracted from implementation_id
+        app_version:
+          type: string
+          description: App Version extracted from implementation_id
+      required:
+        - id
+        - date
+        - account_id
+        - is_invite_only
+        - is_private
+        - shared_with_all
+      description: Normalized connection item returned by getConnection handler
+      example:
+        id: "12345"
+        date: 2023-01-15T10:30:00Z
+        lastchanged: 2023-06-20T14:45:00Z
+        account_id: "98765"
+        destination_selected_api: null
+        is_invite_only: false
+        is_private: true
+        shared_with_all: false
+        is_stale: "false"
+        is_shared: "false"
+        marked_stale_at: null
+        label: My Slack Account
+        identifier: user@example.com
+        title: Slack - Personal Workspace
+        url: /api/v0/connections/12345
+        groups: []
+        members: ""
+        permissions:
+          can_view: true
+          can_delete: true
+        implementation_id: SlackCLIAPI@1.0.0
+        profile_id: "54321"
+        is_expired: "false"
+        expired_at: null
+        app_key: SlackCLIAPI
+        app_version: 1.0.0
+    GetConnectionResponse:
+      type: object
+      properties:
+        data:
+          $ref: "#/components/schemas/ConnectionItem"
+      required:
+        - data
     ListActionsResponse:
       type: object
       properties:
@@ -841,6 +978,143 @@ components:
         - links
         - meta
       description: Response for listing client credentials
+    ListConnectionsResponse:
+      type: object
+      properties:
+        data:
+          type: array
+          items:
+            type: object
+            properties:
+              id:
+                type: string
+                description: Unique identifier for the connection
+              date:
+                type: string
+                description: Date created
+              lastchanged:
+                type: string
+                description: Date last changed
+              account_id:
+                type: string
+                description: Account ID associated with this connection
+              destination_selected_api:
+                type:
+                  - string
+                  - "null"
+                description: Destination API key (if applicable)
+              is_invite_only:
+                type: boolean
+                description: Whether the connection is invite-only
+              is_private:
+                type: boolean
+                description: Whether the connection is private
+              shared_with_all:
+                type: boolean
+                description: Whether the connection is shared with all users
+              is_stale:
+                type: string
+                description: Stale status string
+              is_shared:
+                type: string
+                description: Shared status string
+              marked_stale_at:
+                type:
+                  - string
+                  - "null"
+                description: Date when marked stale
+              label:
+                type:
+                  - string
+                  - "null"
+                description: User label for the connection
+              identifier:
+                type:
+                  - string
+                  - "null"
+                description: Identifier
+              title:
+                type:
+                  - string
+                  - "null"
+                description: Title of the connection
+              url:
+                type: string
+                description: URL to the connection resource
+              groups:
+                type: array
+                items:
+                  type: object
+                  additionalProperties: {}
+                  description: Groups associated with the connection
+                description: Array of groups associated with the connection
+              members:
+                type: string
+                description: Members associated with the connection
+              permissions:
+                type: object
+                additionalProperties:
+                  type: boolean
+                description: Permissions for the connection
+              implementation_id:
+                type: string
+                description: Implementation ID (was selected_api)
+              profile_id:
+                type: string
+                description: Profile ID (was customuser_id)
+              is_expired:
+                type: string
+                description: Whether the connection is expired (mapped from is_stale)
+              expired_at:
+                type:
+                  - string
+                  - "null"
+                description: Date when connection expired (mapped from marked_stale_at)
+              app_key:
+                type: string
+                description: App Key extracted from implementation_id
+              app_version:
+                type: string
+                description: App Version extracted from implementation_id
+            required:
+              - id
+              - date
+              - account_id
+              - is_invite_only
+              - is_private
+              - shared_with_all
+          description: Array of connection items
+        links:
+          type: object
+          properties:
+            next:
+              type:
+                - string
+                - "null"
+              description: Fully qualified URL for the next page of results (if available), e.g. https://sdkapi.zapier.com/api/v0/connections?offset=100&page_size=50
+          description: Pagination links for navigating through results
+        meta:
+          type: object
+          properties:
+            count:
+              type: number
+              description: Total number of items
+            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
+      description: Response schema for listing connections
   parameters: {}
   securitySchemes:
     userJwt:
@@ -939,8 +1213,9 @@ paths:
       operationId: v0_create_client_credentials
       security:
         - userJwt: []
-      x-required-scopes:
-        - credentials
+      x-fastify-config:
+        requiredScopes:
+          - credentials
       requestBody:
         content:
           application/json:
@@ -990,8 +1265,9 @@ paths:
       operationId: v0_list_client_credentials
       security:
         - userJwt: []
-      x-required-scopes:
-        - credentials
+      x-fastify-config:
+        requiredScopes:
+          - credentials
       parameters:
         - schema:
             type: integer
@@ -1050,8 +1326,9 @@ paths:
       operationId: v0_delete_client_credentials
       security:
         - userJwt: []
-      x-required-scopes:
-        - credentials
+      x-fastify-config:
+        requiredScopes:
+          - credentials
       parameters:
         - schema:
             type: string
@@ -1132,7 +1409,8 @@ paths:
   /api/v0/authentications/{authenticationId}:
     get:
       summary: Get an authentication
-      description: Returns a single authentication by ID.
+      description: "Returns a single authentication by ID. Deprecated: Use /api/v0/connections/{connectionId} instead."
+      deprecated: true
       tags:
         - Authentications
       operationId: v0_get_authentication
@@ -1175,6 +1453,52 @@ paths:
           headers: *a6
           content:
             application/json: *a7
+  /api/v0/connections/{connectionId}:
+    get:
+      summary: Get a connection
+      description: Returns a single connection by ID.
+      tags:
+        - Connections
+      operationId: v0_get_connection
+      security:
+        - userJwt: []
+      parameters:
+        - schema:
+            type: string
+            description: Connection ID to retrieve
+          required: true
+          description: Connection ID to retrieve
+          name: connectionId
+          in: path
+      responses:
+        "200":
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/GetConnectionResponse"
+        "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/actions:
     get:
       summary: List actions
@@ -1308,7 +1632,8 @@ paths:
   /api/v0/authentications:
     get:
       summary: List authentications
-      description: Returns a paginated list of authentications with optional filtering by app, search term, owner, etc.
+      description: "Returns a paginated list of authentications with optional filtering by app, search term, owner, etc. Deprecated: Use /api/v0/connections instead."
+      deprecated: true
       tags:
         - Authentications
       operationId: v0_list_authentications
@@ -1408,4 +1733,107 @@ paths:
           headers: *a6
           content:
             application/json: *a7
+  /api/v0/connections:
+    get:
+      summary: List connections
+      description: Returns a paginated list of connections with optional filtering by app, search term, owner, etc.
+      tags:
+        - Connections
+      operationId: v0_list_connections
+      security:
+        - userJwt: []
+      parameters:
+        - schema:
+            type: string
+            description: Filter connections by app key (e.g., 'SlackCLIAPI' or slug like 'github')
+          required: false
+          description: Filter connections by app key (e.g., 'SlackCLIAPI' or slug like 'github')
+          name: app_key
+          in: query
+        - schema:
+            type: string
+            description: Comma-separated list of connection IDs to filter by
+          required: false
+          description: Comma-separated list of connection IDs to filter by
+          name: connection_ids
+          in: query
+        - schema:
+            type: string
+            description: Search term to filter connections by title
+          required: false
+          description: Search term to filter connections by title
+          name: search
+          in: query
+        - schema:
+            type: string
+            description: Filter connections by exact title match (searches first, then filters locally)
+          required: false
+          description: Filter connections by exact title match (searches first, then filters locally)
+          name: title
+          in: query
+        - schema:
+            type: string
+            description: Filter connections by account ID
+          required: false
+          description: Filter connections by account ID
+          name: account_id
+          in: query
+        - schema:
+            type: string
+            description: Filter by owner, 'me' for your own connections or a specific user ID
+          required: false
+          description: Filter by owner, 'me' for your own connections or a specific user ID
+          name: owner
+          in: query
+        - schema:
+            type: boolean
+            description: Filter by expired status (true = expired only, false = non-expired only)
+          required: false
+          description: Filter by expired status (true = expired only, false = non-expired only)
+          name: is_expired
+          in: query
+        - schema:
+            type: number
+            minimum: 1
+            description: Number of connections per page
+          required: false
+          description: Number of connections per page
+          name: page_size
+          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 connections list
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ListConnectionsResponse"
+        "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
 webhooks: {}

package/package.json

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