@zapier/zapier-sdk-core 0.7.0 → 0.7.2

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @zapier/zapier-sdk-core
 
+## 0.7.2
+
+### Patch Changes
+
+- 74f835d: Move x-required-scopes to x-fastify-config.requiredScopes.
+
+## 0.7.1
+
+### Patch Changes
+
+- c740422: Add dedupe method to zapier-sdk-core
+
 ## 0.7.0
 
 ### Minor Changes

package/dist/v0/config/metadata.cjs

@@ -53,6 +53,10 @@ var tags = [
     name: "Client Credentials",
     description: "Client credentials management routes"
   },
+  {
+    name: "Deduplication",
+    description: "Deduplication-related routes"
+  },
   {
     name: "Documentation",
     description: "Documentation-related routes"

package/dist/v0/config/metadata.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/v0/config/metadata.ts"],"sourcesContent":["/**\n * OpenAPI specification metadata\n *\n * This file contains all the base metadata for the OpenAPI specification\n * that was previously stored in openapi-base.yaml.\n *\n * Note on 'as const' usage:\n * - We use 'as const' on literal values that should be treated as enums\n *   (e.g., \"apiKey\", \"header\", \"3.1.0\") to get precise literal types\n * - We avoid 'as const' on top-level configuration objects to prevent\n *   deep readonly types that can cause compatibility issues with libraries\n *   expecting mutable types (like zod-to-openapi)\n * - If you encounter readonly type errors, check whether the consuming\n *   library expects mutable types and remove 'as const' accordingly\n */\n\nexport const apiInfo = {\n  title: \"Zapier SDK API\",\n  version: \"1.0.0\",\n  contact: {\n    email: \"engineering@zapier.com\",\n  },\n  description: \"The Zapier SDK API serves as a backend for the Zapier SDK.\",\n};\n\nexport const servers: Array<{ url: string; description: string }> = [];\n\nexport const tags = [\n  {\n    name: \"Actions\",\n    description: \"Action-related routes\",\n  },\n  {\n    name: \"Apps\",\n    description: \"App-related routes\",\n  },\n  {\n    name: \"Authentications\",\n    description: \"Authentication-related routes\",\n  },\n  {\n    name: \"Client Credentials\",\n    description: \"Client credentials management routes\",\n  },\n  {\n    name: \"Documentation\",\n    description: \"Documentation-related routes\",\n  },\n];\n\n/**\n * Security schemes for OpenAPI specification\n *\n * Note: 'as const' is used on enum-like literal values (\"apiKey\", \"header\")\n * to ensure TypeScript treats them as literal types rather than generic strings.\n * This provides better type safety when the OpenAPI generator validates these values.\n */\nexport const securitySchemes = {\n  userJwt: {\n    type: \"apiKey\" as const,\n    in: \"header\" as const,\n    name: \"Authorization\",\n    description:\n      \"Format should be `JWT <your-jwt>` (you must ensure that the JWT prefix \" +\n      \"is included in your requests).\\\\n\\\\n\" +\n      \"Example:  `Authorization: JWT your.jwt.value.here`\",\n  },\n} as const;\n\n/**\n * Complete OpenAPI metadata for document generation\n */\nexport const openApiMetadata = {\n  openapi: \"3.1.0\" as const,\n  info: apiInfo,\n  servers,\n  tags,\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAgBO,IAAM,UAAU;AAAA,EACrB,OAAO;AAAA,EACP,SAAS;AAAA,EACT,SAAS;AAAA,IACP,OAAO;AAAA,EACT;AAAA,EACA,aAAa;AACf;AAEO,IAAM,UAAuD,CAAC;AAE9D,IAAM,OAAO;AAAA,EAClB;AAAA,IACE,MAAM;AAAA,IACN,aAAa;AAAA,EACf;AAAA,EACA;AAAA,IACE,MAAM;AAAA,IACN,aAAa;AAAA,EACf;AAAA,EACA;AAAA,IACE,MAAM;AAAA,IACN,aAAa;AAAA,EACf;AAAA,EACA;AAAA,IACE,MAAM;AAAA,IACN,aAAa;AAAA,EACf;AAAA,EACA;AAAA,IACE,MAAM;AAAA,IACN,aAAa;AAAA,EACf;AACF;AASO,IAAM,kBAAkB;AAAA,EAC7B,SAAS;AAAA,IACP,MAAM;AAAA,IACN,IAAI;AAAA,IACJ,MAAM;AAAA,IACN,aACE;AAAA,EAGJ;AACF;AAKO,IAAM,kBAAkB;AAAA,EAC7B,SAAS;AAAA,EACT,MAAM;AAAA,EACN;AAAA,EACA;AACF;","names":[]}
+{"version":3,"sources":["../../../src/v0/config/metadata.ts"],"sourcesContent":["/**\n * OpenAPI specification metadata\n *\n * This file contains all the base metadata for the OpenAPI specification\n * that was previously stored in openapi-base.yaml.\n *\n * Note on 'as const' usage:\n * - We use 'as const' on literal values that should be treated as enums\n *   (e.g., \"apiKey\", \"header\", \"3.1.0\") to get precise literal types\n * - We avoid 'as const' on top-level configuration objects to prevent\n *   deep readonly types that can cause compatibility issues with libraries\n *   expecting mutable types (like zod-to-openapi)\n * - If you encounter readonly type errors, check whether the consuming\n *   library expects mutable types and remove 'as const' accordingly\n */\n\nexport const apiInfo = {\n  title: \"Zapier SDK API\",\n  version: \"1.0.0\",\n  contact: {\n    email: \"engineering@zapier.com\",\n  },\n  description: \"The Zapier SDK API serves as a backend for the Zapier SDK.\",\n};\n\nexport const servers: Array<{ url: string; description: string }> = [];\n\nexport const tags = [\n  {\n    name: \"Actions\",\n    description: \"Action-related routes\",\n  },\n  {\n    name: \"Apps\",\n    description: \"App-related routes\",\n  },\n  {\n    name: \"Authentications\",\n    description: \"Authentication-related routes\",\n  },\n  {\n    name: \"Client Credentials\",\n    description: \"Client credentials management routes\",\n  },\n  {\n    name: \"Deduplication\",\n    description: \"Deduplication-related routes\",\n  },\n  {\n    name: \"Documentation\",\n    description: \"Documentation-related routes\",\n  },\n];\n\n/**\n * Security schemes for OpenAPI specification\n *\n * Note: 'as const' is used on enum-like literal values (\"apiKey\", \"header\")\n * to ensure TypeScript treats them as literal types rather than generic strings.\n * This provides better type safety when the OpenAPI generator validates these values.\n */\nexport const securitySchemes = {\n  userJwt: {\n    type: \"apiKey\" as const,\n    in: \"header\" as const,\n    name: \"Authorization\",\n    description:\n      \"Format should be `JWT <your-jwt>` (you must ensure that the JWT prefix \" +\n      \"is included in your requests).\\\\n\\\\n\" +\n      \"Example:  `Authorization: JWT your.jwt.value.here`\",\n  },\n} as const;\n\n/**\n * Complete OpenAPI metadata for document generation\n */\nexport const openApiMetadata = {\n  openapi: \"3.1.0\" as const,\n  info: apiInfo,\n  servers,\n  tags,\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAgBO,IAAM,UAAU;AAAA,EACrB,OAAO;AAAA,EACP,SAAS;AAAA,EACT,SAAS;AAAA,IACP,OAAO;AAAA,EACT;AAAA,EACA,aAAa;AACf;AAEO,IAAM,UAAuD,CAAC;AAE9D,IAAM,OAAO;AAAA,EAClB;AAAA,IACE,MAAM;AAAA,IACN,aAAa;AAAA,EACf;AAAA,EACA;AAAA,IACE,MAAM;AAAA,IACN,aAAa;AAAA,EACf;AAAA,EACA;AAAA,IACE,MAAM;AAAA,IACN,aAAa;AAAA,EACf;AAAA,EACA;AAAA,IACE,MAAM;AAAA,IACN,aAAa;AAAA,EACf;AAAA,EACA;AAAA,IACE,MAAM;AAAA,IACN,aAAa;AAAA,EACf;AAAA,EACA;AAAA,IACE,MAAM;AAAA,IACN,aAAa;AAAA,EACf;AACF;AASO,IAAM,kBAAkB;AAAA,EAC7B,SAAS;AAAA,IACP,MAAM;AAAA,IACN,IAAI;AAAA,IACJ,MAAM;AAAA,IACN,aACE;AAAA,EAGJ;AACF;AAKO,IAAM,kBAAkB;AAAA,EAC7B,SAAS;AAAA,EACT,MAAM;AAAA,EACN;AAAA,EACA;AACF;","names":[]}

package/dist/v0/config/metadata.js

@@ -25,6 +25,10 @@ var tags = [
     name: "Client Credentials",
     description: "Client credentials management routes"
   },
+  {
+    name: "Deduplication",
+    description: "Deduplication-related routes"
+  },
   {
     name: "Documentation",
     description: "Documentation-related routes"

package/dist/v0/config/metadata.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/v0/config/metadata.ts"],"sourcesContent":["/**\n * OpenAPI specification metadata\n *\n * This file contains all the base metadata for the OpenAPI specification\n * that was previously stored in openapi-base.yaml.\n *\n * Note on 'as const' usage:\n * - We use 'as const' on literal values that should be treated as enums\n *   (e.g., \"apiKey\", \"header\", \"3.1.0\") to get precise literal types\n * - We avoid 'as const' on top-level configuration objects to prevent\n *   deep readonly types that can cause compatibility issues with libraries\n *   expecting mutable types (like zod-to-openapi)\n * - If you encounter readonly type errors, check whether the consuming\n *   library expects mutable types and remove 'as const' accordingly\n */\n\nexport const apiInfo = {\n  title: \"Zapier SDK API\",\n  version: \"1.0.0\",\n  contact: {\n    email: \"engineering@zapier.com\",\n  },\n  description: \"The Zapier SDK API serves as a backend for the Zapier SDK.\",\n};\n\nexport const servers: Array<{ url: string; description: string }> = [];\n\nexport const tags = [\n  {\n    name: \"Actions\",\n    description: \"Action-related routes\",\n  },\n  {\n    name: \"Apps\",\n    description: \"App-related routes\",\n  },\n  {\n    name: \"Authentications\",\n    description: \"Authentication-related routes\",\n  },\n  {\n    name: \"Client Credentials\",\n    description: \"Client credentials management routes\",\n  },\n  {\n    name: \"Documentation\",\n    description: \"Documentation-related routes\",\n  },\n];\n\n/**\n * Security schemes for OpenAPI specification\n *\n * Note: 'as const' is used on enum-like literal values (\"apiKey\", \"header\")\n * to ensure TypeScript treats them as literal types rather than generic strings.\n * This provides better type safety when the OpenAPI generator validates these values.\n */\nexport const securitySchemes = {\n  userJwt: {\n    type: \"apiKey\" as const,\n    in: \"header\" as const,\n    name: \"Authorization\",\n    description:\n      \"Format should be `JWT <your-jwt>` (you must ensure that the JWT prefix \" +\n      \"is included in your requests).\\\\n\\\\n\" +\n      \"Example:  `Authorization: JWT your.jwt.value.here`\",\n  },\n} as const;\n\n/**\n * Complete OpenAPI metadata for document generation\n */\nexport const openApiMetadata = {\n  openapi: \"3.1.0\" as const,\n  info: apiInfo,\n  servers,\n  tags,\n};\n"],"mappings":";AAgBO,IAAM,UAAU;AAAA,EACrB,OAAO;AAAA,EACP,SAAS;AAAA,EACT,SAAS;AAAA,IACP,OAAO;AAAA,EACT;AAAA,EACA,aAAa;AACf;AAEO,IAAM,UAAuD,CAAC;AAE9D,IAAM,OAAO;AAAA,EAClB;AAAA,IACE,MAAM;AAAA,IACN,aAAa;AAAA,EACf;AAAA,EACA;AAAA,IACE,MAAM;AAAA,IACN,aAAa;AAAA,EACf;AAAA,EACA;AAAA,IACE,MAAM;AAAA,IACN,aAAa;AAAA,EACf;AAAA,EACA;AAAA,IACE,MAAM;AAAA,IACN,aAAa;AAAA,EACf;AAAA,EACA;AAAA,IACE,MAAM;AAAA,IACN,aAAa;AAAA,EACf;AACF;AASO,IAAM,kBAAkB;AAAA,EAC7B,SAAS;AAAA,IACP,MAAM;AAAA,IACN,IAAI;AAAA,IACJ,MAAM;AAAA,IACN,aACE;AAAA,EAGJ;AACF;AAKO,IAAM,kBAAkB;AAAA,EAC7B,SAAS;AAAA,EACT,MAAM;AAAA,EACN;AAAA,EACA;AACF;","names":[]}
+{"version":3,"sources":["../../../src/v0/config/metadata.ts"],"sourcesContent":["/**\n * OpenAPI specification metadata\n *\n * This file contains all the base metadata for the OpenAPI specification\n * that was previously stored in openapi-base.yaml.\n *\n * Note on 'as const' usage:\n * - We use 'as const' on literal values that should be treated as enums\n *   (e.g., \"apiKey\", \"header\", \"3.1.0\") to get precise literal types\n * - We avoid 'as const' on top-level configuration objects to prevent\n *   deep readonly types that can cause compatibility issues with libraries\n *   expecting mutable types (like zod-to-openapi)\n * - If you encounter readonly type errors, check whether the consuming\n *   library expects mutable types and remove 'as const' accordingly\n */\n\nexport const apiInfo = {\n  title: \"Zapier SDK API\",\n  version: \"1.0.0\",\n  contact: {\n    email: \"engineering@zapier.com\",\n  },\n  description: \"The Zapier SDK API serves as a backend for the Zapier SDK.\",\n};\n\nexport const servers: Array<{ url: string; description: string }> = [];\n\nexport const tags = [\n  {\n    name: \"Actions\",\n    description: \"Action-related routes\",\n  },\n  {\n    name: \"Apps\",\n    description: \"App-related routes\",\n  },\n  {\n    name: \"Authentications\",\n    description: \"Authentication-related routes\",\n  },\n  {\n    name: \"Client Credentials\",\n    description: \"Client credentials management routes\",\n  },\n  {\n    name: \"Deduplication\",\n    description: \"Deduplication-related routes\",\n  },\n  {\n    name: \"Documentation\",\n    description: \"Documentation-related routes\",\n  },\n];\n\n/**\n * Security schemes for OpenAPI specification\n *\n * Note: 'as const' is used on enum-like literal values (\"apiKey\", \"header\")\n * to ensure TypeScript treats them as literal types rather than generic strings.\n * This provides better type safety when the OpenAPI generator validates these values.\n */\nexport const securitySchemes = {\n  userJwt: {\n    type: \"apiKey\" as const,\n    in: \"header\" as const,\n    name: \"Authorization\",\n    description:\n      \"Format should be `JWT <your-jwt>` (you must ensure that the JWT prefix \" +\n      \"is included in your requests).\\\\n\\\\n\" +\n      \"Example:  `Authorization: JWT your.jwt.value.here`\",\n  },\n} as const;\n\n/**\n * Complete OpenAPI metadata for document generation\n */\nexport const openApiMetadata = {\n  openapi: \"3.1.0\" as const,\n  info: apiInfo,\n  servers,\n  tags,\n};\n"],"mappings":";AAgBO,IAAM,UAAU;AAAA,EACrB,OAAO;AAAA,EACP,SAAS;AAAA,EACT,SAAS;AAAA,IACP,OAAO;AAAA,EACT;AAAA,EACA,aAAa;AACf;AAEO,IAAM,UAAuD,CAAC;AAE9D,IAAM,OAAO;AAAA,EAClB;AAAA,IACE,MAAM;AAAA,IACN,aAAa;AAAA,EACf;AAAA,EACA;AAAA,IACE,MAAM;AAAA,IACN,aAAa;AAAA,EACf;AAAA,EACA;AAAA,IACE,MAAM;AAAA,IACN,aAAa;AAAA,EACf;AAAA,EACA;AAAA,IACE,MAAM;AAAA,IACN,aAAa;AAAA,EACf;AAAA,EACA;AAAA,IACE,MAAM;AAAA,IACN,aAAa;AAAA,EACf;AAAA,EACA;AAAA,IACE,MAAM;AAAA,IACN,aAAa;AAAA,EACf;AACF;AASO,IAAM,kBAAkB;AAAA,EAC7B,SAAS;AAAA,IACP,MAAM;AAAA,IACN,IAAI;AAAA,IACJ,MAAM;AAAA,IACN,aACE;AAAA,EAGJ;AACF;AAKO,IAAM,kBAAkB;AAAA,EAC7B,SAAS;AAAA,EACT,MAAM;AAAA,EACN;AAAA,EACA;AACF;","names":[]}

package/openapi.yaml

@@ -19,6 +19,8 @@ tags:
     description: Authentication-related routes
   - name: Client Credentials
     description: Client credentials management routes
+  - name: Deduplication
+    description: Deduplication-related routes
   - name: Documentation
     description: Documentation-related routes
 components:
@@ -153,6 +155,50 @@ components:
       required:
         - errors
       description: A JSON:API error response document containing an array of error objects.
+    CheckDedupeResponse:
+      type: object
+      properties:
+        data:
+          type: object
+          properties:
+            is_duplicate:
+              type: boolean
+              description: Whether this combination of dedupe_key and parameters has been seen before
+            dedupe_id:
+              type: string
+              format: uuid
+              description: Unique identifier for this dedupe record
+            created_at:
+              type: string
+              format: date-time
+              description: ISO 8601 timestamp when the record was created
+            expires_at:
+              type: string
+              format: date-time
+              description: ISO 8601 timestamp when the record will expire
+          required:
+            - is_duplicate
+            - dedupe_id
+            - created_at
+            - expires_at
+          description: The dedupe check result
+      required:
+        - data
+    CheckDedupeRequest:
+      type: object
+      properties:
+        dedupe_key:
+          type: string
+          minLength: 1
+          maxLength: 255
+          description: A key to namespace the deduplication check
+        parameters:
+          type: object
+          additionalProperties: {}
+          description: Parameters object to check for duplicates. The hash is computed from this object.
+      required:
+        - dedupe_key
+        - parameters
     CreateClientCredentialsResponse:
       type: object
       properties:
@@ -803,36 +849,35 @@ 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/client-credentials:
+  /api/v0/dedupe/check:
     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.
+      summary: Check for duplicate
+      description: Checks if a combination of dedupe_key and parameters has been seen before. If new, stores the hash and returns is_duplicate=false. If exists, returns is_duplicate=true. Records automatically expire after 7 days.
       tags:
-        - Client Credentials
-      operationId: v0_create_client_credentials
+        - Deduplication
+      operationId: v0_check_dedupe
       security:
         - userJwt: []
-      x-required-scopes:
-        - credentials
       requestBody:
         content:
           application/json:
             schema:
-              $ref: "#/components/schemas/CreateClientCredentialsRequest"
+              $ref: "#/components/schemas/CheckDedupeRequest"
             examples:
               default:
-                summary: Create credentials with external scope
+                summary: Check for duplicate email send
                 value:
-                  name: My App Credentials
-                  allowed_scopes:
-                    - external
+                  dedupe_key: email-campaign-123
+                  parameters:
+                    email: user@example.com
+                    template_id: welcome-email
       responses:
-        "201":
-          description: Client credentials created successfully
+        "200":
+          description: Dedupe check completed successfully
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/CreateClientCredentialsResponse"
+                $ref: "#/components/schemas/CheckDedupeResponse"
         "400":
           description: Bad Request
           content:
@@ -885,6 +930,59 @@ paths:
             application/json: &a7
               schema:
                 $ref: "#/components/schemas/ErrorsResponse"
+  /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:
+        - Client Credentials
+      operationId: v0_create_client_credentials
+      security:
+        - userJwt: []
+      x-fastify-config:
+        requiredScopes:
+          - 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:
+        "201":
+          description: Client credentials created successfully
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/CreateClientCredentialsResponse"
+        "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
     get:
       summary: List client credentials
       description: Returns a paginated list of client credentials for the authenticated user.
@@ -893,8 +991,9 @@ paths:
       operationId: v0_list_client_credentials
       security:
         - userJwt: []
-      x-required-scopes:
-        - credentials
+      x-fastify-config:
+        requiredScopes:
+          - credentials
       parameters:
         - schema:
             type: integer
@@ -953,8 +1052,9 @@ paths:
       operationId: v0_delete_client_credentials
       security:
         - userJwt: []
-      x-required-scopes:
-        - credentials
+      x-fastify-config:
+        requiredScopes:
+          - credentials
       parameters:
         - schema:
             type: string

package/package.json

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