zapier-platform-cli 16.3.0 → 16.4.0

package/oclif.manifest.json

@@ -178,11 +178,18 @@
           "required": true
         }
       },
-      "description": "Mark a non-production version of your integration as deprecated, with removal by a certain date.\n\nUse this when an integration version will not be supported or start breaking at a known date.\n\nZapier will send an email warning users of the deprecation once a date is set, they'll start seeing it as \"Deprecated\" in the UI, and once the deprecation date arrives, if the Zaps weren't updated, they'll be paused and the users will be emailed again explaining what happened.\n\nAfter the deprecation date has passed it will be safe to delete that integration version.\n\nDo not use this if you have non-breaking changes, such as fixing help text.",
+      "description": "Mark a non-production version of your integration as deprecated, with removal by a certain date.\n\nUse this when an integration version will not be supported or start breaking at a known date.\n\nZapier will immediately send emails warning users of the deprecation if a date less than 30 days in the future is set, otherwise the emails will be sent exactly 30 days before the configured deprecation date.\n\nThere are other side effects: they'll start seeing it as \"Deprecated\" in the UI, and once the deprecation date arrives, if the Zaps weren't updated, they'll be paused and the users will be emailed again explaining what happened.\n\nDo not use deprecation if you only have non-breaking changes, such as:\n- Fixing help text\n- Adding new triggers/actions\n- Improving existing functionality\n- other bug fixes that don't break existing automations.",
       "examples": [
         "zapier deprecate 1.2.3 2011-10-01"
       ],
       "flags": {
+        "force": {
+          "char": "f",
+          "description": "Skip confirmation prompt. Use with caution.",
+          "name": "force",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "debug": {
           "char": "d",
           "description": "Show extra debugging output.",
@@ -349,6 +356,7 @@
             "minimal",
             "oauth1-trello",
             "oauth2",
+            "openai",
             "search-or-create",
             "session-auth",
             "typescript"
@@ -458,7 +466,7 @@
           "name": "actionKey"
         }
       },
-      "description": "Invoke an auth operation, a trigger, or a create/search action locally.\n\nThis command emulates how Zapier production environment would invoke your integration. It runs code locally, so you can use this command to quickly test your integration without deploying it to Zapier. This is especially useful for debugging and development.\n\nThis command loads environment variables and `authData` from the `.env` file in the current directory. If you don't have a `.env` file yet, you can use the `zapier invoke auth start` command to help you initialize it, or you can manually create it.\n\nThe `zapier invoke auth start` subcommand will prompt you for the necessary auth fields and save them to the `.env` file. For OAuth2, it will start a local HTTP server, open the authorization URL in the browser, wait for the OAuth2 redirect, and get the access token.\n\nEach line in the `.env` file should follow one of these formats:\n\n* `VAR_NAME=VALUE` for environment variables\n* `authData_FIELD_KEY=VALUE` for auth data fields\n\nFor example, a `.env` file for an OAuth2 integration might look like this:\n\n```\nCLIENT_ID='your_client_id'\nCLIENT_SECRET='your_client_secret'\nauthData_access_token='1234567890'\nauthData_refresh_token='abcdefg'\nauthData_account_name='zapier'\n```\n\nTo test if the auth data is correct, run either one of these:\n\n```\nzapier invoke auth test   # invokes authentication.test method\nzapier invoke auth label  # invokes authentication.test and renders connection label\n```\n\nTo refresh stale auth data for OAuth2 or session auth, run `zapier invoke auth refresh`.\n\nOnce you have the correct auth data, you can test an trigger, a search, or a create action. For example, here's how you invoke a trigger with the key `new_recipe`:\n\n```\nzapier invoke trigger new_recipe\n```\n\nTo add input data, use the `--inputData` flag. The input data can come from the command directly, a file, or stdin. See **EXAMPLES** below.\n\nWhen you miss any command arguments, such as ACTIONTYPE or ACTIONKEY, the command will prompt you interactively. If you don't want to get interactive prompts, use the `--non-interactive` flag.\n\nThe `--debug` flag will show you the HTTP request logs and any console logs you have in your code.\n\nThe following is a non-exhaustive list of current limitations and may be supported in the future:\n\n- Hook triggers, including REST hook subscribe/unsubscribe\n- Line items\n- Output hydration\n- File upload\n- Dynamic dropdown pagination\n- Function-based connection label\n- Buffered create actions\n- Search-or-create actions\n- Search-powered fields\n- Field choices\n- autoRefresh for OAuth2 and session auth\n",
+      "description": "Invoke an auth operation, a trigger, or a create/search action locally.\n\nThis command emulates how Zapier production environment would invoke your integration. It runs code locally, so you can use this command to quickly test your integration without deploying it to Zapier. This is especially useful for debugging and development.\n\nWhy use this command?\n\n* Fast feedback loop: Write code and run this command to verify if it works immediately\n* Step-by-step debugging: Running locally means you can use a debugger to step through your code\n* Untruncated logs: View complete logs and errors in your terminal\n\n### Authentication\n\nYou can supply the authentcation data in two ways: Load from the local `.env` file or use the (experimental) `--authentication-id` flag.\n\n#### The local `.env` file\n\nThis command loads environment variables and `authData` from the `.env` file in the current directory. If you don't have a `.env` file yet, you can use the `zapier invoke auth start` command to help you initialize it, or you can manually create it.\n\nThe `zapier invoke auth start` subcommand will prompt you for the necessary auth fields and save them to the `.env` file. For OAuth2, it will start a local HTTP server, open the authorization URL in the browser, wait for the OAuth2 redirect, and get the access token.\n\nEach line in the `.env` file should follow one of these formats:\n\n* `VAR_NAME=VALUE` for environment variables\n* `authData_FIELD_KEY=VALUE` for auth data fields\n\nFor example, a `.env` file for an OAuth2 integration might look like this:\n\n```\nCLIENT_ID='your_client_id'\nCLIENT_SECRET='your_client_secret'\nauthData_access_token='1234567890'\nauthData_refresh_token='abcdefg'\nauthData_account_name='zapier'\n```\n\n\n#### The `--authentication-id` flag (EXPERIMENTAL)\n\nSetting up local auth data can be troublesome. You'd have to configure your app server to allow localhost redirect URIs or use a port forwarding tool. This is sometimes not easy to get right.\n\nThe `--authentication-id` flag (`-a` for short) gives you an alternative (and perhaps easier) way to supply your auth data. You can use `-a` to specify an existing production authentication/connection. The available authentications can be found at https://zapier.com/app/assets/connections. Check https://zpr.io/z8SjFTdnTFZ2 for more instructions.\n\nWhen `-a -` is specified, such as `zapier invoke auth test -a -`, the command will interactively prompt you to select one of your available authentications.\n\nIf you know your authentication ID, you can specify it directly, such as `zapier invoke auth test -a 123456`.\n\n#### Testing authentication\n\nTo test if the auth data is correct, run either one of these:\n\n```\nzapier invoke auth test   # invokes authentication.test method\nzapier invoke auth label  # invokes authentication.test and renders connection label\n```\n\nTo refresh stale auth data for OAuth2 or session auth, run `zapier invoke auth refresh`. Note that refreshing is only applicable for local auth data in the `.env` file.\n\n### Invoking a trigger or an action\n\nOnce you have the correct auth data, you can test an trigger, a search, or a create action. For example, here's how you invoke a trigger with the key `new_recipe`:\n\n```\nzapier invoke trigger new_recipe\n```\n\nTo add input data, use the `--inputData` flag (`-i` for short). The input data can come from the command directly, a file, or stdin. See **EXAMPLES** below.\n\nWhen you miss any command arguments, such as ACTIONTYPE or ACTIONKEY, the command will prompt you interactively. If you don't want to get interactive prompts, use the `--non-interactive` flag.\n\nThe `--debug` flag will show you the HTTP request logs and any console logs you have in your code.\n\n### Limitations\n\nThe following is a non-exhaustive list of current limitations and may be supported in the future:\n\n- Hook triggers, including REST hook subscribe/unsubscribe\n- Line items\n- Output hydration\n- File upload\n- Dynamic dropdown pagination\n- Function-based connection label\n- Buffered create actions\n- Search-or-create actions\n- Search-powered fields\n- Field choices\n- autoRefresh for OAuth2 and session auth\n",
       "examples": [
         "zapier invoke",
         "zapier invoke auth start",
@@ -467,8 +475,10 @@
         "zapier invoke auth label",
         "zapier invoke trigger new_recipe",
         "zapier invoke create add_recipe --inputData '{\"title\": \"Pancakes\"}'",
-        "zapier invoke search find_recipe -i @file.json",
-        "cat file.json | zapier invoke trigger new_recipe -i @-"
+        "zapier invoke search find_recipe -i @file.json --non-interactive",
+        "cat file.json | zapier invoke trigger new_recipe -i @-",
+        "zapier invoke search find_ticket --authentication-id 12345",
+        "zapier invoke create add_ticket -a -"
       ],
       "flags": {
         "inputData": {
@@ -545,6 +555,14 @@
           "multiple": false,
           "type": "option"
         },
+        "authentication-id": {
+          "char": "a",
+          "description": "EXPERIMENTAL: Instead of using the local .env file, use the production authentication data with the given authentication ID (aka the \"app connection\" on Zapier). Find them at https://zapier.com/app/assets/connections (https://zpr.io/z8SjFTdnTFZ2 for instructions) or specify '-' to interactively select one from your available authentications. When specified, the code will still run locally, but all outgoing requests will be proxied through Zapier with the production auth data.",
+          "name": "authentication-id",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "debug": {
           "char": "d",
           "description": "Show extra debugging output.",
@@ -1540,13 +1558,44 @@
         "clear.js"
       ]
     },
-    "delete:integration": {
-      "aliases": [
-        "delete:app"
+    "canary:create": {
+      "aliases": [],
+      "args": {
+        "versionFrom": {
+          "description": "Version to route traffic from",
+          "name": "versionFrom",
+          "required": true
+        },
+        "versionTo": {
+          "description": "Version to canary traffic to",
+          "name": "versionTo",
+          "required": true
+        }
+      },
+      "description": "Create a new canary deployment, diverting a specified percentage of traffic from one version to another for a specified duration.\n\nOnly one canary can be active at the same time. You can run `zapier canary:list` to check. If you would like to create a new canary with different parameters, you can wait for the canary to finish, or delete it using `zapier canary:delete a.b.c x.y.z`.\n\nNote: this is similar to `zapier migrate` but different in that this is temporary and will \"revert\" the changes once the specified duration is expired.\n\n**Only use this command to canary traffic between non-breaking versions!**",
+      "examples": [
+        "zapier canary:create 1.0.0 1.1.0 -p 25 -d 720",
+        "zapier canary:create 2.0.0 2.1.0 --percent 50 --duration 300"
       ],
-      "args": {},
-      "description": "Delete your integration (including all versions).\n\nThis only works if there are no active users or Zaps on any version. If you only want to delete certain versions, use the `zapier delete:version` command instead. It's unlikely that you'll be able to run this on an app that you've pushed publicly, since there are usually still users.",
       "flags": {
+        "percent": {
+          "char": "p",
+          "description": "Percent of traffic to route to new version",
+          "name": "percent",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "duration": {
+          "char": "d",
+          "description": "Duration of the canary in seconds",
+          "name": "duration",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "debug": {
           "char": "d",
           "description": "Show extra debugging output.",
@@ -1563,7 +1612,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "delete:integration",
+      "id": "canary:create",
       "pluginAlias": "zapier-platform-cli",
       "pluginName": "zapier-platform-cli",
       "pluginType": "core",
@@ -1575,20 +1624,54 @@
         "src",
         "oclif",
         "commands",
-        "delete",
-        "integration.js"
+        "canary",
+        "create.js"
       ]
     },
-    "delete:version": {
+    "canary:delete": {
       "aliases": [],
       "args": {
-        "version": {
-          "description": "Specify the version to delete. It must have no users or Zaps.",
-          "name": "version",
+        "versionFrom": {
+          "description": "Version to route traffic from",
+          "name": "versionFrom",
+          "required": true
+        },
+        "versionTo": {
+          "description": "Version canary traffic is routed to",
+          "name": "versionTo",
           "required": true
         }
       },
-      "description": "Delete a specific version of your integration.\n\nThis only works if there are no users or Zaps on that version. You will probably need to have run `zapier migrate` and `zapier deprecate` before this command will work.",
+      "description": "Delete an active canary deployment",
+      "examples": [
+        "zapier canary:delete 1.0.0 1.1.0"
+      ],
+      "flags": {},
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "canary:delete",
+      "pluginAlias": "zapier-platform-cli",
+      "pluginName": "zapier-platform-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "skipValidInstallCheck": true,
+      "isESM": false,
+      "relativePath": [
+        "src",
+        "oclif",
+        "commands",
+        "canary",
+        "delete.js"
+      ]
+    },
+    "canary:list": {
+      "aliases": [],
+      "args": {},
+      "description": "List all active canary deployments",
+      "examples": [
+        "zapier canary:list"
+      ],
       "flags": {
         "debug": {
           "char": "d",
@@ -1597,6 +1680,22 @@
           "allowNo": false,
           "type": "boolean"
         },
+        "format": {
+          "char": "f",
+          "description": "Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq.",
+          "name": "format",
+          "default": "table",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "plain",
+            "json",
+            "raw",
+            "row",
+            "table"
+          ],
+          "type": "option"
+        },
         "invokedFromAnotherCommand": {
           "hidden": true,
           "name": "invokedFromAnotherCommand",
@@ -1606,7 +1705,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "delete:version",
+      "id": "canary:list",
       "pluginAlias": "zapier-platform-cli",
       "pluginName": "zapier-platform-cli",
       "pluginType": "core",
@@ -1618,8 +1717,8 @@
         "src",
         "oclif",
         "commands",
-        "delete",
-        "version.js"
+        "canary",
+        "list.js"
       ]
     },
     "env:get": {
@@ -1798,44 +1897,13 @@
         "unset.js"
       ]
     },
-    "canary:create": {
-      "aliases": [],
-      "args": {
-        "versionFrom": {
-          "description": "Version to route traffic from",
-          "name": "versionFrom",
-          "required": true
-        },
-        "versionTo": {
-          "description": "Version to canary traffic to",
-          "name": "versionTo",
-          "required": true
-        }
-      },
-      "description": "Create a new canary deployment, diverting a specified percentage of traffic from one version to another for a specified duration.\n\nOnly one canary can be active at the same time. You can run `zapier canary:list` to check. If you would like to create a new canary with different parameters, you can wait for the canary to finish, or delete it using `zapier canary:delete a.b.c x.y.z`.\n\nNote: this is similar to `zapier migrate` but different in that this is temporary and will \"revert\" the changes once the specified duration is expired.\n\n**Only use this command to canary traffic between non-breaking versions!**",
-      "examples": [
-        "zapier canary:create 1.0.0 1.1.0 -p 25 -d 720",
-        "zapier canary:create 2.0.0 2.1.0 --percent 50 --duration 300"
+    "delete:integration": {
+      "aliases": [
+        "delete:app"
       ],
+      "args": {},
+      "description": "Delete your integration (including all versions).\n\nThis only works if there are no active users or Zaps on any version. If you only want to delete certain versions, use the `zapier delete:version` command instead. It's unlikely that you'll be able to run this on an app that you've pushed publicly, since there are usually still users.",
       "flags": {
-        "percent": {
-          "char": "p",
-          "description": "Percent of traffic to route to new version",
-          "name": "percent",
-          "required": true,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "duration": {
-          "char": "d",
-          "description": "Duration of the canary in seconds",
-          "name": "duration",
-          "required": true,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
         "debug": {
           "char": "d",
           "description": "Show extra debugging output.",
@@ -1852,7 +1920,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "canary:create",
+      "id": "delete:integration",
       "pluginAlias": "zapier-platform-cli",
       "pluginName": "zapier-platform-cli",
       "pluginType": "core",
@@ -1864,54 +1932,20 @@
         "src",
         "oclif",
         "commands",
-        "canary",
-        "create.js"
+        "delete",
+        "integration.js"
       ]
     },
-    "canary:delete": {
+    "delete:version": {
       "aliases": [],
       "args": {
-        "versionFrom": {
-          "description": "Version to route traffic from",
-          "name": "versionFrom",
-          "required": true
-        },
-        "versionTo": {
-          "description": "Version canary traffic is routed to",
-          "name": "versionTo",
+        "version": {
+          "description": "Specify the version to delete. It must have no users or Zaps.",
+          "name": "version",
           "required": true
         }
       },
-      "description": "Delete an active canary deployment",
-      "examples": [
-        "zapier canary:delete 1.0.0 1.1.0"
-      ],
-      "flags": {},
-      "hasDynamicHelp": false,
-      "hiddenAliases": [],
-      "id": "canary:delete",
-      "pluginAlias": "zapier-platform-cli",
-      "pluginName": "zapier-platform-cli",
-      "pluginType": "core",
-      "strict": true,
-      "enableJsonFlag": false,
-      "skipValidInstallCheck": true,
-      "isESM": false,
-      "relativePath": [
-        "src",
-        "oclif",
-        "commands",
-        "canary",
-        "delete.js"
-      ]
-    },
-    "canary:list": {
-      "aliases": [],
-      "args": {},
-      "description": "List all active canary deployments",
-      "examples": [
-        "zapier canary:list"
-      ],
+      "description": "Delete a specific version of your integration.\n\nThis only works if there are no users or Zaps on that version. You will probably need to have run `zapier migrate` and `zapier deprecate` before this command will work.",
       "flags": {
         "debug": {
           "char": "d",
@@ -1920,22 +1954,6 @@
           "allowNo": false,
           "type": "boolean"
         },
-        "format": {
-          "char": "f",
-          "description": "Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq.",
-          "name": "format",
-          "default": "table",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "options": [
-            "plain",
-            "json",
-            "raw",
-            "row",
-            "table"
-          ],
-          "type": "option"
-        },
         "invokedFromAnotherCommand": {
           "hidden": true,
           "name": "invokedFromAnotherCommand",
@@ -1945,7 +1963,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "canary:list",
+      "id": "delete:version",
       "pluginAlias": "zapier-platform-cli",
       "pluginName": "zapier-platform-cli",
       "pluginType": "core",
@@ -1957,8 +1975,8 @@
         "src",
         "oclif",
         "commands",
-        "canary",
-        "list.js"
+        "delete",
+        "version.js"
       ]
     },
     "team:add": {
@@ -2340,5 +2358,5 @@
       ]
     }
   },
-  "version": "16.3.0"
+  "version": "16.4.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zapier-platform-cli",
-  "version": "16.3.0",
+  "version": "16.4.0",
   "description": "The CLI for managing integrations in Zapier Developer Platform.",
   "repository": "zapier/zapier-platform",
   "homepage": "https://platform.zapier.com/",

package/src/generators/index.js

@@ -201,6 +201,7 @@ const TEMPLATE_ROUTES = {
   minimal: writeForMinimalTemplate,
   'oauth1-trello': writeForAuthTemplate,
   oauth2: writeForAuthTemplate,
+  openai: writeForStandaloneTemplate,
   'search-or-create': writeForStandaloneTemplate,
   'session-auth': writeForAuthTemplate,
   typescript: writeForStandaloneTypeScriptTemplate,

package/src/generators/templates/openai/README.md

@@ -0,0 +1,3 @@
+# OpenAI
+
+This Zapier integration project is generated by the `zapier init` CLI command. This integration in particular is using the OpenAI API to generate responses to prompts from users. For this integration, there is a `constants.js` file that will allow you to swap out the base URL and version of the API to swap if you are using an OpenAI compatible API to get started.

package/src/generators/templates/openai/authentication.js

@@ -0,0 +1,46 @@
+const { API_URL } = require('./constants');
+// You want to make a request to an endpoint that is either specifically designed
+// to test auth, or one that every user will have access to. eg: `/me`.
+// By returning the entire request object, you have access to the request and
+// response data for testing purposes. Your connection label can access any data
+// from the returned response using the `json.` prefix. eg: `{{json.username}}`.
+const test = (z, bundle) => z.request({ url: `${API_URL}/me` });
+
+module.exports = {
+  // "custom" is the catch-all auth type. The user supplies some info and Zapier can
+  // make authenticated requests with it
+  type: 'custom',
+
+  // Define any input app's auth requires here. The user will be prompted to enter
+  // this info when they connect their account.
+  fields: [
+    {
+      key: 'api_key',
+      label: 'API Key',
+      required: true,
+      helpText:
+        'Generate an API Key in your [Platform settings page](https://platform.openai.com/api-keys).',
+    },
+    // This field is optional and can be removed if not needed
+    {
+      key: 'organization_id',
+      required: false,
+      label: 'Organization ID',
+      helpText:
+        '**Optional** Only required if your OpenAI account belongs to multiple organizations. If not using OpenAI, this field will be disregarded. If your OpenAI account belongs to multiple organizations, optionally add the [Organization ID](https://platform.openai.com/account/org-settings) that this connection should use. If left blank, your [default organization](https://platform.openai.com/account/api-keys) will be used.',
+    },
+  ],
+
+  // The test method allows Zapier to verify that the credentials a user provides
+  // are valid. We'll execute this method whenever a user connects their account for
+  // the first time.
+  test,
+
+  // This template string can access all the data returned from the auth test. If
+  // you return the test object, you'll access the returned data with a label like
+  // `{{json.X}}`. If you return `response.data` from your test, then your label can
+  // be `{{X}}`. This can also be a function that returns a label. That function has
+  // the standard args `(z, bundle)` and data returned from the test can be accessed
+  // in `bundle.inputData.X`.
+  connectionLabel: '{{json.email}}',
+};

package/src/generators/templates/openai/constants.js

@@ -0,0 +1,10 @@
+const BASE_URL = 'https://api.openai.com';
+const VERSION = 'v1';
+const API_URL = `${BASE_URL}/${VERSION}`;
+
+const DEFAULT_MODEL = 'gpt-4o-mini';
+
+module.exports = {
+  API_URL,
+  DEFAULT_MODEL,
+};

package/src/generators/templates/openai/creates/chat_completion.js

@@ -0,0 +1,164 @@
+/* eslint-disable camelcase */
+const { API_URL, DEFAULT_MODEL } = require('../constants');
+
+const sample = require('../samples/chat.json');
+
+async function getAdvancedFields(_z, bundle) {
+  if (bundle.inputData.show_advanced === true) {
+    return [
+      {
+        key: 'info_advanced',
+        type: 'copy',
+        helpText:
+          "The following fields are for advanced users and should be used with caution as they may affect performance. In most cases, the default options are sufficient. If you'd like to explore these options further, you can [learn more here](https://help.zapier.com/hc/en-us/articles/22497191078797).",
+      },
+      {
+        key: 'developer_message',
+        label: 'Developer/System Message',
+        type: 'text',
+        helpText:
+          'Instructions to the model that are prioritized ahead of user messages, following [chain of command](https://cdn.openai.com/spec/model-spec-2024-05-08.html#follow-the-chain-of-command).',
+      },
+      {
+        key: 'temperature',
+        label: 'Temperature',
+        type: 'number',
+        helpText:
+          'Higher values mean the model will take more risks. Try 0.9 for more creative applications, and 0 for ones with a well-defined answer.\n\nUse a decimal between 0 and 1.',
+      },
+      {
+        key: 'max_completion_tokens',
+        label: 'Maximum Length',
+        type: 'integer',
+        helpText: 'The maximum number of tokens for the completion.',
+      },
+    ];
+  }
+  return [];
+}
+
+async function perform(z, bundle) {
+  const {
+    user_message,
+    model,
+    files,
+    developer_message,
+    temperature,
+    max_completion_tokens,
+  } = bundle.inputData;
+
+  const developerMessage = {
+    role: 'developer',
+    content: [
+      {
+        type: 'text',
+        text: developer_message || 'You are a helpful assistant.',
+      },
+    ],
+  };
+
+  const userMessage = {
+    role: 'user',
+    content: [
+      {
+        type: 'text',
+        text: user_message,
+      },
+      ...(files
+        ? files.map((file) => ({
+            type: 'image_url',
+            image_url: {
+              url: file,
+            },
+          }))
+        : []),
+    ],
+  };
+
+  const messages = [developerMessage, userMessage];
+
+  const response = await z.request({
+    url: `${API_URL}/chat/completions`,
+    method: 'POST',
+    body: JSON.stringify({
+      model,
+      messages,
+      temperature,
+      max_completion_tokens,
+    }),
+  });
+  return response.data;
+}
+
+module.exports = {
+  key: 'chat_completion',
+  noun: 'Chat',
+  display: {
+    label: 'Chat Completion',
+    description: 'Sends a Chat to OpenAI and generates a Completion.',
+  },
+  operation: {
+    perform,
+    inputFields: [
+      {
+        key: 'info_data_usage',
+        type: 'copy',
+        helpText:
+          "Data sent to OpenAI through this Zap is via an API. Under OpenAI's [API data usage policy](https://openai.com/policies/api-data-usage-policies), OpenAI will not use API-submitted data to train or improve their models unless you explicitly decide to share your data with them for that purpose (such as by opting in). For more information, please review OpenAI's article about [when/how data may be used to improve model performance](https://help.openai.com/en/articles/5722486-how-your-data-is-used-to-improve-model-performance).",
+      },
+      {
+        key: 'user_message',
+        label: 'User Message',
+        type: 'text',
+        helpText:
+          "Instructions that request some output from the model. Similar to messages you'd type in [ChatGPT](https://chatgpt.com) as an end user.",
+        required: true,
+      },
+      {
+        key: 'files',
+        label: 'Images',
+        type: 'file',
+        helpText: 'Images to include along with your message.',
+        list: true,
+      },
+      {
+        key: 'model',
+        label: 'Model',
+        type: 'string',
+        required: true,
+        default: DEFAULT_MODEL, // Optional to default to a specific model for most users
+        dynamic: 'list_models.id.name',
+        altersDynamicFields: false,
+      },
+      {
+        key: 'show_advanced',
+        label: 'Show Advanced Options',
+        type: 'boolean',
+        default: 'false',
+        altersDynamicFields: true,
+      },
+      getAdvancedFields,
+    ],
+    // Rename some of the output fields to be more descriptive for a user
+    outputFields: [
+      { key: 'id', type: 'string', label: 'Completion ID' },
+      { key: 'model', type: 'string', label: 'Model' },
+      {
+        key: 'usage__prompt_tokens',
+        type: 'number',
+        label: 'Usage: Prompt Tokens',
+      },
+      {
+        key: 'usage__completion_tokens',
+        type: 'number',
+        label: 'Usage: Completion Tokens',
+      },
+      {
+        key: 'usage__total_tokens',
+        type: 'number',
+        label: 'Usage: Total Tokens',
+      },
+    ],
+    sample,
+  },
+};

package/src/generators/templates/openai/creates/index.js

@@ -0,0 +1,7 @@
+/* eslint-disable camelcase */
+const chat_completion = require('./chat_completion');
+
+// If you add a new create, make sure it is exported here to display in the Zapier Editor
+module.exports = {
+  [chat_completion.key]: chat_completion,
+};

package/src/generators/templates/openai/dynamic_dropdowns/index.js

@@ -0,0 +1,7 @@
+/* eslint-disable camelcase */
+const list_models = require('./list_models.js');
+
+// If you add a new Dynamic Dropdown, make sure it is exported here to display in the Zapier Editor
+module.exports = {
+  [list_models.key]: list_models,
+};