zapier-platform-schema 11.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (72) hide show
  1. package/CHANGELOG.md +3 -0
  2. package/LICENSE +4 -0
  3. package/README.md +21 -0
  4. package/exported-schema.json +1418 -0
  5. package/lib/constants.js +21 -0
  6. package/lib/functional-constraints/deepNestedFields.js +68 -0
  7. package/lib/functional-constraints/index.js +35 -0
  8. package/lib/functional-constraints/labelWhenVisible.js +31 -0
  9. package/lib/functional-constraints/matchingKeys.js +35 -0
  10. package/lib/functional-constraints/mutuallyExclusiveFields.js +70 -0
  11. package/lib/functional-constraints/requiredSamples.js +56 -0
  12. package/lib/functional-constraints/searchOrCreateKeys.js +67 -0
  13. package/lib/functional-constraints/uniqueInputFieldKeys.js +67 -0
  14. package/lib/schemas/AppFlagsSchema.js +22 -0
  15. package/lib/schemas/AppSchema.js +148 -0
  16. package/lib/schemas/AuthenticationBasicConfigSchema.js +14 -0
  17. package/lib/schemas/AuthenticationCustomConfigSchema.js +14 -0
  18. package/lib/schemas/AuthenticationDigestConfigSchema.js +14 -0
  19. package/lib/schemas/AuthenticationOAuth1ConfigSchema.js +53 -0
  20. package/lib/schemas/AuthenticationOAuth2ConfigSchema.js +73 -0
  21. package/lib/schemas/AuthenticationSchema.js +118 -0
  22. package/lib/schemas/AuthenticationSessionConfigSchema.js +31 -0
  23. package/lib/schemas/BasicActionOperationSchema.js +59 -0
  24. package/lib/schemas/BasicCreateActionOperationSchema.js +26 -0
  25. package/lib/schemas/BasicDisplaySchema.js +92 -0
  26. package/lib/schemas/BasicHookOperationSchema.js +117 -0
  27. package/lib/schemas/BasicOperationSchema.js +73 -0
  28. package/lib/schemas/BasicPollingOperationSchema.js +41 -0
  29. package/lib/schemas/BulkReadSchema.js +72 -0
  30. package/lib/schemas/BulkReadsSchema.js +69 -0
  31. package/lib/schemas/BundleSchema.js +17 -0
  32. package/lib/schemas/CreateSchema.js +108 -0
  33. package/lib/schemas/CreatesSchema.js +78 -0
  34. package/lib/schemas/DynamicFieldsSchema.js +36 -0
  35. package/lib/schemas/FieldChoiceWithLabelSchema.js +37 -0
  36. package/lib/schemas/FieldChoicesSchema.js +40 -0
  37. package/lib/schemas/FieldOrFunctionSchema.js +40 -0
  38. package/lib/schemas/FieldSchema.js +183 -0
  39. package/lib/schemas/FieldsSchema.js +17 -0
  40. package/lib/schemas/FlatObjectSchema.js +45 -0
  41. package/lib/schemas/FunctionRequireSchema.js +28 -0
  42. package/lib/schemas/FunctionSchema.js +42 -0
  43. package/lib/schemas/FunctionSourceSchema.js +37 -0
  44. package/lib/schemas/HydratorsSchema.js +29 -0
  45. package/lib/schemas/KeySchema.js +30 -0
  46. package/lib/schemas/MiddlewaresSchema.js +35 -0
  47. package/lib/schemas/RedirectRequestSchema.js +41 -0
  48. package/lib/schemas/RefResourceSchema.js +24 -0
  49. package/lib/schemas/RequestSchema.js +109 -0
  50. package/lib/schemas/ResourceMethodCreateSchema.js +67 -0
  51. package/lib/schemas/ResourceMethodGetSchema.js +74 -0
  52. package/lib/schemas/ResourceMethodHookSchema.js +72 -0
  53. package/lib/schemas/ResourceMethodListSchema.js +76 -0
  54. package/lib/schemas/ResourceMethodSearchSchema.js +67 -0
  55. package/lib/schemas/ResourceSchema.js +168 -0
  56. package/lib/schemas/ResourcesMethodGetSchema.js +57 -0
  57. package/lib/schemas/ResourcesSchema.js +95 -0
  58. package/lib/schemas/ResultsSchema.js +25 -0
  59. package/lib/schemas/SearchOrCreateSchema.js +84 -0
  60. package/lib/schemas/SearchOrCreatesSchema.js +60 -0
  61. package/lib/schemas/SearchSchema.js +84 -0
  62. package/lib/schemas/SearchesSchema.js +54 -0
  63. package/lib/schemas/TriggerSchema.js +93 -0
  64. package/lib/schemas/TriggersSchema.js +61 -0
  65. package/lib/schemas/VersionSchema.js +18 -0
  66. package/lib/utils/buildDocs.js +213 -0
  67. package/lib/utils/exportSchema.js +23 -0
  68. package/lib/utils/links.js +27 -0
  69. package/lib/utils/makeSchema.js +27 -0
  70. package/lib/utils/makeValidator.js +150 -0
  71. package/package.json +40 -0
  72. package/schema.js +13 -0
package/CHANGELOG.md ADDED
@@ -0,0 +1,3 @@
1
+ Read docs: https://zapier.github.io/zapier-platform/.
2
+
3
+ Changelog: https://github.com/zapier/zapier-platform/blob/master/CHANGELOG.md
package/LICENSE ADDED
@@ -0,0 +1,4 @@
1
+ Copyright (c) Zapier, Inc.
2
+
3
+ This repository is part of Zapier Platform, of which license terms can be found at
4
+ https://zapier.com/platform/tos.
package/README.md ADDED
@@ -0,0 +1,21 @@
1
+ # Schema For Zapier CLI Platform
2
+
3
+ [Visit the CLI for basic documentation and instructions on how to use](https://zapier.github.io/zapier-platform-cli).
4
+
5
+ [View all the schema definitions](https://zapier.github.io/zapier-platform-schema/build/schema.html).
6
+
7
+ ## Development
8
+
9
+ - `yarn` to install packages and get started
10
+ - `yarn lint` to lint code
11
+ - `yarn test` to run tests
12
+ - `yarn smoke-test` to run smoke tests
13
+ - `yarn coverage` to run tests and display test coverage
14
+ - `yarn validate` to run tests, smoke tests, and linter
15
+ - `yarn export` to update the exported-schema (even if only the version changes)
16
+ - `yarn docs` to update docs (even if only the version changes)
17
+ - `yarn build` to update docs and the exported-schema (even if only the version changes)
18
+
19
+ ## Publishing (after merging)
20
+
21
+ - `yarn version --[patch|minor|major]` will pull, test, update exported-schema, update docs, increment version in package.json, push tags, and publish to npm