zapier-platform-schema 15.2.0 → 15.3.0

package/exported-schema.json

@@ -1,5 +1,5 @@
 {
-  "version": "15.2.0",
+  "version": "15.3.0",
   "schemas": {
     "AppSchema": {
       "id": "/AppSchema",
@@ -318,28 +318,6 @@
         }
       ]
     },
-    "RedirectRequestSchema": {
-      "id": "/RedirectRequestSchema",
-      "description": "A representation of a HTTP redirect - you can use the `{{syntax}}` to inject authentication, field or global variables.",
-      "type": "object",
-      "properties": {
-        "method": {
-          "description": "The HTTP method for the request.",
-          "type": "string",
-          "default": "GET",
-          "enum": ["GET"]
-        },
-        "url": {
-          "description": "A URL for the request (we will parse the querystring and merge with params). Keys and values will not be re-encoded.",
-          "type": "string"
-        },
-        "params": {
-          "description": "A mapping of the querystring - will get merged with any query params in the URL. Keys and values will be encoded.",
-          "$ref": "/FlatObjectSchema"
-        }
-      },
-      "additionalProperties": false
-    },
     "RequestSchema": {
       "id": "/RequestSchema",
       "description": "A representation of a HTTP request - you can use the `{{syntax}}` to inject authentication, field or global variables.",
@@ -429,6 +407,28 @@
       },
       "additionalProperties": false
     },
+    "RedirectRequestSchema": {
+      "id": "/RedirectRequestSchema",
+      "description": "A representation of a HTTP redirect - you can use the `{{syntax}}` to inject authentication, field or global variables.",
+      "type": "object",
+      "properties": {
+        "method": {
+          "description": "The HTTP method for the request.",
+          "type": "string",
+          "default": "GET",
+          "enum": ["GET"]
+        },
+        "url": {
+          "description": "A URL for the request (we will parse the querystring and merge with params). Keys and values will not be re-encoded.",
+          "type": "string"
+        },
+        "params": {
+          "description": "A mapping of the querystring - will get merged with any query params in the URL. Keys and values will be encoded.",
+          "$ref": "/FlatObjectSchema"
+        }
+      },
+      "additionalProperties": false
+    },
     "FieldsSchema": {
       "id": "/FieldsSchema",
       "description": "An array or collection of fields.",
@@ -448,7 +448,19 @@
       "id": "/AuthenticationCustomConfigSchema",
       "description": "Config for custom authentication (like API keys). No extra properties are required to setup this auth type, so you can leave this empty if your app uses a custom auth method.",
       "type": "object",
-      "properties": {},
+      "properties": {
+        "sendCode": {
+          "description": "EXPERIMENTAL: Define the call Zapier should make to send the OTP code.",
+          "oneOf": [
+            {
+              "$ref": "/RequestSchema"
+            },
+            {
+              "$ref": "/FunctionSchema"
+            }
+          ]
+        }
+      },
       "additionalProperties": false
     },
     "AuthenticationDigestConfigSchema": {

package/lib/schemas/AuthenticationCustomConfigSchema.js

@@ -1,14 +1,37 @@
 'use strict';
 
 const makeSchema = require('../utils/makeSchema');
+const FunctionSchema = require('./FunctionSchema');
+const RequestSchema = require('./RequestSchema');
 
-module.exports = makeSchema({
-  id: '/AuthenticationCustomConfigSchema',
-  description:
-    'Config for custom authentication (like API keys). No extra properties are required to setup this auth type, so you can leave this empty if your app uses a custom auth method.',
-  type: 'object',
-  properties: {},
-  additionalProperties: false,
-  examples: [{}],
-  antiExamples: [{ example: { foo: true }, reason: 'Invalid key.' }],
-});
+module.exports = makeSchema(
+  {
+    id: '/AuthenticationCustomConfigSchema',
+    description:
+      'Config for custom authentication (like API keys). No extra properties are required to setup this auth type, so you can leave this empty if your app uses a custom auth method.',
+    type: 'object',
+    properties: {
+      sendCode: {
+        description:
+          'EXPERIMENTAL: Define the call Zapier should make to send the OTP code.',
+        oneOf: [{ $ref: RequestSchema.id }, { $ref: FunctionSchema.id }],
+      },
+    },
+    additionalProperties: false,
+    examples: [
+      {},
+      {
+        sendCode: {
+          url: 'https://example.com/api/send',
+          headers: { Authorization: `Bearer {{process.env.API_KEY}}` },
+          body: {
+            to_phone_number: '{{bundle.inputData.phone_number}}',
+            code: '{{bundle.inputData.code}}',
+          },
+        },
+      },
+    ],
+    antiExamples: [{ example: { foo: true }, reason: 'Invalid key.' }],
+  },
+  [RequestSchema, FunctionSchema]
+);

package/package.json

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