zapier-platform-schema 15.7.3 → 15.8.0

package/exported-schema.json

@@ -637,7 +637,7 @@
           "enum": ["free", "trial", "paid"]
         },
         "retry": {
-          "description": "The effect of throttling on the tasks of the action. `true` means throttled tasks are automatically retried after some delay, while `false` means tasks are held without retry. It defaults to `true`.",
+          "description": "The effect of throttling on the tasks of the action. `true` means throttled tasks are automatically retried after some delay, while `false` means tasks are held without retry. It defaults to `true`. NOTE that it has no effect on polling triggers and should not be set.",
           "type": "boolean"
         }
       },
@@ -717,6 +717,15 @@
             "type": "string"
           }
         },
+        "retry": {
+          "description": "The effect of throttling on the tasks of the action. `true` means throttled tasks are automatically retried after some delay, while `false` means tasks are held without retry. It defaults to `true`. NOTE that it has no effect on polling triggers and should not be set.",
+          "type": "boolean"
+        },
+        "filter": {
+          "description": "EXPERIMENTAL: Account-based attribute to override the throttle by. You can set to one of the following: \"free\", \"trial\", \"paid\". Therefore, the throttle scope would be automatically set to \"account\" and ONLY the accounts based on the specified filter will have their requests throttled based on the throttle overrides while the rest are throttled based on the original configuration.",
+          "type": "string",
+          "enum": ["free", "trial", "paid"]
+        },
         "overrides": {
           "description": "EXPERIMENTAL: Overrides the original throttle configuration based on a Zapier account attribute.",
           "type": "array",
@@ -919,10 +928,6 @@
               "value": "**yes** (with exceptions, see description)"
             }
           }
-        },
-        "throttle": {
-          "description": "Zapier uses this configuration to apply throttling when the limit for the window is exceeded.",
-          "$ref": "/ThrottleObjectSchema"
         }
       },
       "additionalProperties": false
@@ -1494,7 +1499,8 @@
           "description": "Any unique key can be used and its values will be validated against the SearchOrCreateSchema.",
           "$ref": "/SearchOrCreateSchema"
         }
-      }
+      },
+      "additionalProperties": false
     },
     "AuthenticationSchema": {
       "id": "/AuthenticationSchema",
@@ -1602,7 +1608,8 @@
           "description": "Any unique key can be used and its values will be validated against the SearchSchema.",
           "$ref": "/SearchSchema"
         }
-      }
+      },
+      "additionalProperties": false
     },
     "CreatesSchema": {
       "id": "/CreatesSchema",
@@ -1613,7 +1620,8 @@
           "description": "Any unique key can be used and its values will be validated against the CreateSchema.",
           "$ref": "/CreateSchema"
         }
-      }
+      },
+      "additionalProperties": false
     },
     "SearchAndCreatesSchema": {
       "id": "/SearchAndCreatesSchema",
@@ -1624,7 +1632,8 @@
           "description": "Any unique key can be used and its values will be validated against the SearchOrCreateSchema.",
           "$ref": "/SearchOrCreateSchema"
         }
-      }
+      },
+      "additionalProperties": false
     },
     "VersionSchema": {
       "id": "/VersionSchema",

package/lib/functional-constraints/index.js

@@ -18,6 +18,7 @@ const checks = [
   require('./matchingKeys'),
   require('./labelWhenVisible'),
   require('./uniqueInputFieldKeys'),
+  require('./pollingThrottle'),
 ];
 
 const runFunctionalConstraints = (definition, mainSchema) => {

package/lib/functional-constraints/pollingThrottle.js

@@ -0,0 +1,35 @@
+'use strict';
+
+const _ = require('lodash');
+const jsonschema = require('jsonschema');
+
+const pollingThrottle = (definition) => {
+  const errors = [];
+  const actionType = 'triggers';
+
+  if (definition[actionType]) {
+    _.each(definition[actionType], (actionDef) => {
+      if (
+        actionDef.operation &&
+        actionDef.operation.throttle &&
+        _.has(actionDef.operation.throttle, 'retry') &&
+        (!actionDef.operation.type || actionDef.operation.type === 'polling')
+      ) {
+        errors.push(
+          new jsonschema.ValidationError(
+            'must not use the "retry" field for a polling trigger.',
+            actionDef.operation.throttle,
+            '/ThrottleObjectSchema',
+            `instance.${actionType}.${actionDef.key}.operation.throttle`,
+            'invalid',
+            'throttle'
+          )
+        );
+      }
+    });
+  }
+
+  return errors;
+};
+
+module.exports = pollingThrottle;

package/lib/schemas/BasicHookOperationSchema.js

@@ -83,7 +83,6 @@ BasicHookOperationSchema.properties = {
   inputFields: BasicHookOperationSchema.properties.inputFields,
   outputFields: BasicHookOperationSchema.properties.outputFields,
   sample: BasicHookOperationSchema.properties.sample,
-  throttle: BasicHookOperationSchema.properties.throttle,
 };
 
 BasicHookOperationSchema.examples = [

package/lib/schemas/CreatesSchema.js

@@ -17,6 +17,7 @@ module.exports = makeSchema(
         $ref: CreateSchema.id,
       },
     },
+    additionalProperties: false,
     examples: [
       {
         createRecipe: {

package/lib/schemas/SearchOrCreatesSchema.js

@@ -18,6 +18,7 @@ module.exports = makeSchema(
         $ref: SearchOrCreateSchema.id,
       },
     },
+    additionalProperties: false,
     examples: [
       {
         searchOrCreateWidgets: {

package/lib/schemas/SearchesSchema.js

@@ -17,6 +17,7 @@ module.exports = makeSchema(
         $ref: SearchSchema.id,
       },
     },
+    additionalProperties: false,
     examples: [
       {
         recipe: {

package/lib/schemas/ThrottleObjectSchema.js

@@ -36,6 +36,16 @@ module.exports = makeSchema(
           type: 'string',
         },
       },
+      retry: {
+        description:
+          'The effect of throttling on the tasks of the action. `true` means throttled tasks are automatically retried after some delay, while `false` means tasks are held without retry. It defaults to `true`. NOTE that it has no effect on polling triggers and should not be set.',
+        type: 'boolean',
+      },
+      filter: {
+        description: `EXPERIMENTAL: Account-based attribute to override the throttle by. You can set to one of the following: "free", "trial", "paid". Therefore, the throttle scope would be automatically set to "account" and ONLY the accounts based on the specified filter will have their requests throttled based on the throttle overrides while the rest are throttled based on the original configuration.`,
+        type: 'string',
+        enum: ['free', 'trial', 'paid'],
+      },
       overrides: {
         description:
           'EXPERIMENTAL: Overrides the original throttle configuration based on a Zapier account attribute.',
@@ -72,11 +82,13 @@ module.exports = makeSchema(
         limit: 10,
         key: 'random_key-{{bundle.inputData.test_field}}',
         scope: ['action', 'auth'],
+        retry: false,
       },
       {
         window: 3600,
         limit: 10,
         scope: ['auth'],
+        retry: false,
         overrides: [
           {
             window: 3600,

package/lib/schemas/ThrottleOverrideObjectSchema.js

@@ -26,7 +26,7 @@ module.exports = makeSchema({
     },
     retry: {
       description:
-        'The effect of throttling on the tasks of the action. `true` means throttled tasks are automatically retried after some delay, while `false` means tasks are held without retry. It defaults to `true`.',
+        'The effect of throttling on the tasks of the action. `true` means throttled tasks are automatically retried after some delay, while `false` means tasks are held without retry. It defaults to `true`. NOTE that it has no effect on polling triggers and should not be set.',
       type: 'boolean',
     },
   },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zapier-platform-schema",
-  "version": "15.7.3",
+  "version": "15.8.0",
   "description": "Schema definition for CLI apps in the Zapier Developer Platform.",
   "repository": "zapier/zapier-platform",
   "homepage": "https://platform.zapier.com/",