@zapier/zapier-sdk-core 0.6.0 → 0.7.0

package/openapi.yaml

@@ -17,6 +17,8 @@ tags:
     description: App-related routes
   - name: Authentications
     description: Authentication-related routes
+  - name: Client Credentials
+    description: Client credentials management routes
   - name: Documentation
     description: Documentation-related routes
 components:
@@ -151,6 +153,50 @@ components:
       required:
         - errors
       description: A JSON:API error response document containing an array of error objects.
+    CreateClientCredentialsResponse:
+      type: object
+      properties:
+        data:
+          type: object
+          properties:
+            client_id:
+              type: string
+              description: The public identifier (Client ID) of the OAuth application
+            name:
+              type: string
+              description: Human-readable name of the OAuth application
+            client_secret:
+              type: string
+              description: The client secret (only shown once on creation)
+          required:
+            - client_id
+            - name
+            - client_secret
+          description: The created client credentials (includes client_secret)
+      required:
+        - data
+      description: Response for creating client credentials
+    CreateClientCredentialsRequest:
+      type: object
+      properties:
+        name:
+          type: string
+          minLength: 1
+          maxLength: 255
+          description: Human-readable name for the client credentials
+        allowed_scopes:
+          type: array
+          items:
+            type: string
+            enum:
+              - credentials
+              - external
+          minItems: 1
+          description: List of OAuth scopes that this application will be allowed to request
+      required:
+        - name
+        - allowed_scopes
+      description: Request body for creating client credentials
     AuthenticationItem:
       type: object
       properties:
@@ -681,6 +727,74 @@ components:
         - links
         - meta
       description: Response schema for listing authentications
+    ListClientCredentialsResponse:
+      type: object
+      properties:
+        data:
+          type: array
+          items:
+            type: object
+            properties:
+              client_id:
+                type: string
+                description: The public identifier (Client ID) of the OAuth application
+              name:
+                type: string
+                description: Human-readable name of the OAuth application
+              allowed_scopes:
+                type: array
+                items:
+                  type: string
+                  enum:
+                    - credentials
+                    - external
+                description: List of OAuth scopes that this application is allowed to request
+              created_at:
+                type:
+                  - string
+                  - "null"
+                format: date-time
+                description: When the application was created (ISO 8601)
+              updated_at:
+                type: string
+                format: date-time
+                description: When the application was last updated (ISO 8601)
+            required:
+              - client_id
+              - name
+              - allowed_scopes
+          description: Array of client credentials
+        links:
+          type: object
+          properties:
+            next:
+              type:
+                - string
+                - "null"
+              description: URL for the next page of results (if available)
+          description: Pagination links
+        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: Pagination metadata
+      required:
+        - data
+        - links
+        - meta
+      description: Response for listing client credentials
   parameters: {}
   securitySchemes:
     userJwt:
@@ -689,22 +803,36 @@ components:
       name: Authorization
       description: "Format should be `JWT <your-jwt>` (you must ensure that the JWT prefix is included in your requests).\\n\\nExample:  `Authorization: JWT your.jwt.value.here`"
 paths:
-  /api/v0/docs/openapi-spec:
-    get:
-      summary: OpenAPI Specification
-      description: Serves the OpenAPI specification file
+  /api/v0/client-credentials:
+    post:
+      summary: Create client credentials
+      description: Creates new client credentials for the authenticated user. The client_secret is only returned once in this response and cannot be retrieved again.
       tags:
-        - Documentation
-      operationId: v0_docs_openapi_spec
-      security: []
+        - Client Credentials
+      operationId: v0_create_client_credentials
+      security:
+        - userJwt: []
+      x-required-scopes:
+        - credentials
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/CreateClientCredentialsRequest"
+            examples:
+              default:
+                summary: Create credentials with external scope
+                value:
+                  name: My App Credentials
+                  allowed_scopes:
+                    - external
       responses:
-        "200":
-          description: OpenAPI specification
+        "201":
+          description: Client credentials created successfully
           content:
-            text/yaml:
+            application/json:
               schema:
-                type: string
-                description: OpenAPI specification in YAML format
+                $ref: "#/components/schemas/CreateClientCredentialsResponse"
         "400":
           description: Bad Request
           content:
@@ -757,6 +885,153 @@ paths:
             application/json: &a7
               schema:
                 $ref: "#/components/schemas/ErrorsResponse"
+    get:
+      summary: List client credentials
+      description: Returns a paginated list of client credentials for the authenticated user.
+      tags:
+        - Client Credentials
+      operationId: v0_list_client_credentials
+      security:
+        - userJwt: []
+      x-required-scopes:
+        - credentials
+      parameters:
+        - schema:
+            type: integer
+            minimum: 1
+            maximum: 100
+            description: "Number of items per page (default: 100, max: 100)"
+          required: false
+          description: "Number of items per page (default: 100, max: 100)"
+          name: pageSize
+          in: query
+        - schema:
+            type:
+              - integer
+              - "null"
+            minimum: 0
+            description: Pagination offset
+          required: false
+          description: Pagination offset
+          name: offset
+          in: query
+      responses:
+        "200":
+          description: Successfully retrieved client credentials list
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ListClientCredentialsResponse"
+        "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/{clientId}:
+    delete:
+      summary: Delete client credentials
+      description: Deletes client credentials by client ID. Returns 404 if the credentials do not exist or are not owned by the authenticated user.
+      tags:
+        - Client Credentials
+      operationId: v0_delete_client_credentials
+      security:
+        - userJwt: []
+      x-required-scopes:
+        - credentials
+      parameters:
+        - schema:
+            type: string
+            description: The client ID of the credentials to delete
+          required: true
+          description: The client ID of the credentials to delete
+          name: clientId
+          in: path
+      responses:
+        "204":
+          description: Client credentials deleted successfully
+        "400":
+          description: Bad Request
+          content:
+            application/json: *a1
+        "401":
+          description: Unauthorized
+          content:
+            application/json: *a2
+        "404":
+          description: Client credentials not found
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorsResponse"
+        "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/docs/openapi-spec:
+    get:
+      summary: OpenAPI Specification
+      description: Serves the OpenAPI specification file
+      tags:
+        - Documentation
+      operationId: v0_docs_openapi_spec
+      security: []
+      responses:
+        "200":
+          description: OpenAPI specification
+          content:
+            text/yaml:
+              schema:
+                type: string
+                description: OpenAPI specification in YAML format
+        "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/{authenticationId}:
     get:
       summary: Get an authentication

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zapier/zapier-sdk-core",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "Core schemas and TypeScript types for the Zapier SDK API",
   "license": "SEE LICENSE IN LICENSE",
   "author": "Zapier, Inc.",
@@ -51,6 +51,11 @@
       "import": "./dist/v0/schemas/actions.js",
       "require": "./dist/v0/schemas/actions.cjs"
     },
+    "./v0/schemas/client-credentials": {
+      "types": "./dist/v0/schemas/client-credentials.d.ts",
+      "import": "./dist/v0/schemas/client-credentials.js",
+      "require": "./dist/v0/schemas/client-credentials.cjs"
+    },
     "./v0/common/responses": {
       "types": "./dist/v0/common/responses.d.ts",
       "import": "./dist/v0/common/responses.js",