@zapier/zapier-sdk-core 0.11.0 → 0.12.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @zapier/zapier-sdk-core
 
+## 0.12.0
+
+### Minor Changes
+
+- 821a368: Add `POST /api/v0/approvals` endpoint. The SDK calls this to create an approval request after receiving a `403 x-zapier-error-type: approval_required` from a proxy or handler. The body carries a typed request context (`http_request` or `action_run`).
+
 ## 0.11.0
 
 ### Minor Changes

package/openapi.yaml

@@ -203,6 +203,139 @@ components:
       required:
         - dedupe_key
         - parameters
+    ApprovalResponse:
+      type: object
+      properties:
+        status:
+          type: string
+          enum:
+            - pending_approval
+            - approved
+            - denied
+          description: The current status of the approval request
+        approval_id:
+          type: string
+          description: Unique identifier for the approval request
+        approval_url:
+          type: string
+          description: URL for the user to visit and approve/deny the request
+        poll_url:
+          type: string
+          description: URL for the SDK to poll for status changes
+      required:
+        - status
+        - approval_id
+    ParsedUrl:
+      type: object
+      properties:
+        scheme:
+          type: string
+          description: URL scheme (e.g. https)
+        host:
+          type: string
+          description: Hostname
+        port:
+          type: number
+          description: Port number
+        path:
+          type: string
+          description: URL path
+        query:
+          type: object
+          additionalProperties:
+            type: array
+            items:
+              type: string
+          description: Query parameters
+      required:
+        - scheme
+        - host
+        - port
+        - path
+        - query
+      description: Parsed URL components
+    HttpRequestContext:
+      type: object
+      properties:
+        request_type:
+          type: string
+          enum:
+            - http_request
+          description: Context type discriminator
+        method:
+          type: string
+          description: HTTP method
+        url:
+          $ref: "#/components/schemas/ParsedUrl"
+        headers:
+          type: object
+          additionalProperties:
+            type: string
+          description: Filtered headers (IGNORED_HEADERS excluded, keys lowercased)
+        body:
+          type:
+            - string
+            - "null"
+          description: Raw body string
+        body_json:
+          description: Parsed JSON body
+        connection_id:
+          type: string
+          description: Zapier connection ID used for this request
+        reason:
+          type: string
+          description: Human-readable reason
+      required:
+        - request_type
+        - method
+        - url
+        - headers
+        - body
+    ActionRunContext:
+      type: object
+      properties:
+        request_type:
+          type: string
+          enum:
+            - action_run
+          description: Context type discriminator
+        selected_api:
+          type: string
+          description: Selected API identifier
+        action_type:
+          type: string
+          description: Action type
+        action_key:
+          type: string
+          description: Action key
+        connection_id:
+          type: string
+          description: Zapier connection ID
+        inputs:
+          description: Action input parameters
+        reason:
+          type: string
+          description: Human-readable reason
+      required:
+        - request_type
+        - selected_api
+        - action_type
+        - action_key
+    CreateApprovalBody:
+      type: object
+      properties:
+        context:
+          oneOf:
+            - $ref: "#/components/schemas/HttpRequestContext"
+            - $ref: "#/components/schemas/ActionRunContext"
+          discriminator:
+            propertyName: request_type
+            mapping:
+              http_request: "#/components/schemas/HttpRequestContext"
+              action_run: "#/components/schemas/ActionRunContext"
+          description: The request context for the approval — either an HTTP request context or an action run context
+      required:
+        - context
     CreateClientCredentialsResponse:
       type: object
       properties:
@@ -251,28 +384,6 @@ components:
         - name
         - allowed_scopes
       description: Request body for creating client credentials
-    ApprovalResponse:
-      type: object
-      properties:
-        status:
-          type: string
-          enum:
-            - pending_approval
-            - approved
-            - denied
-          description: The current status of the approval request
-        approval_id:
-          type: string
-          description: Unique identifier for the approval request
-        approval_url:
-          type: string
-          description: URL for the user to visit and approve/deny the request
-        poll_url:
-          type: string
-          description: URL for the SDK to poll for status changes
-      required:
-        - status
-        - approval_id
     AuthenticationItem:
       type: object
       properties:
@@ -1268,6 +1379,49 @@ paths:
             application/json: &a7
               schema:
                 $ref: "#/components/schemas/ErrorsResponse"
+  /api/v0/approvals:
+    post:
+      summary: Create an approval request
+      description: Creates an approval request for the authenticated user. The SDK calls this when it decides to proceed with an approval flow after receiving an approval-required error.
+      tags:
+        - Approvals
+      operationId: v0_create_approval
+      security:
+        - userJwt: []
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/CreateApprovalBody"
+      responses:
+        "202":
+          description: Approval request created
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ApprovalResponse"
+        "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/client-credentials:
     post:
       summary: Create client credentials

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zapier/zapier-sdk-core",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "Core schemas and TypeScript types for the Zapier SDK API",
   "license": "SEE LICENSE IN LICENSE",
   "author": "Zapier, Inc.",