forms-api25-sdk-js

v0.0.4

Published

6 months ago

JS API client generated by OpenAPI Generator

0High
0Medium
0Low

formstack_api2025

FormstackApi2025 - JavaScript client for formstack_api2025 No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) This SDK is automatically generated by the OpenAPI Generator project:

API version: 0.0.4
Package version: 0.0.4
Generator version: 7.13.0-SNAPSHOT
Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install formstack_api2025 --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your formstack_api2025 from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var FormstackApi2025 = require('formstack_api2025');


var api = new FormstackApi2025.ClassicApi()
var formId = 56; // {Number} The ID of the form
var opts = {
  'includeIntegrations': true, // {IncludeIntegrations} Flag to specify whether to copy integrations
  'includeEmails': true, // {IncludeEmails} Flag to specify whether to copy emails
  'template': 56, // {Template} Id of template to use when copying
  'folder': 56 // {Folder} Id of folder where copy should be saved
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.copyForm(formId, opts, callback);

Documentation for API Endpoints

All URIs are relative to https://staging-formstack.com/api/v2025

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- FormstackApi2025.ClassicApi | copyForm | POST /forms/{formId}/copy | FormstackApi2025.ClassicApi | countFormSubmissions | GET /forms/{formId}/submissions/count | FormstackApi2025.ClassicApi | createConfirmationEmail | POST /forms/{formId}/confirmations | FormstackApi2025.ClassicApi | createFieldInForm | POST /forms/{formId}/fields | FormstackApi2025.ClassicApi | createFolder | POST /folders | FormstackApi2025.ClassicApi | createForm | POST /forms | FormstackApi2025.ClassicApi | createFormPrefill | POST /forms/{formId}/prefill | FormstackApi2025.ClassicApi | createNotificationEmail | POST /forms/{formId}/notifications | FormstackApi2025.ClassicApi | createSubmission | POST /forms/{formId}/submissions | FormstackApi2025.ClassicApi | deleteConfirmationEmail | DELETE /confirmations/{confirmationId} | FormstackApi2025.ClassicApi | deleteField | DELETE /forms/{formId}/fields/{fieldId} | FormstackApi2025.ClassicApi | deleteFolder | DELETE /folders/{folderId} | FormstackApi2025.ClassicApi | deleteForm | DELETE /forms/{formId} | FormstackApi2025.ClassicApi | deleteNotificationEmail | DELETE /notifications/{notificationId} | FormstackApi2025.ClassicApi | deletePartialSubmission | DELETE /partialsubmission/{partialSubmissionId} | FormstackApi2025.ClassicApi | deleteSubmission | DELETE /submissions/{submissionId} | FormstackApi2025.ClassicApi | editField | PUT /forms/{formId}/fields/{fieldId} | FormstackApi2025.ClassicApi | editFolder | PUT /folders/{folderId} | FormstackApi2025.ClassicApi | editForm | PUT /forms/{formId} | FormstackApi2025.ClassicApi | editSubmission | PUT /submissions/{submissionId} | FormstackApi2025.ClassicApi | getConfirmation | GET /confirmations/{confirmationId} | FormstackApi2025.ClassicApi | getFieldDetails | GET /forms/{formId}/fields/{fieldId} | FormstackApi2025.ClassicApi | getFolder | GET /folders/{folderId} | FormstackApi2025.ClassicApi | getFormConfirmationEmails | GET /forms/{formId}/confirmations | FormstackApi2025.ClassicApi | getFormDetails | GET /forms/{formId} | FormstackApi2025.ClassicApi | getFormFields | GET /forms/{formId}/fields | FormstackApi2025.ClassicApi | getFormHtml | GET /forms/{formId}/html | FormstackApi2025.ClassicApi | getFormJavascript | GET /forms/{formId}/javascript | FormstackApi2025.ClassicApi | getFormNotificationEmails | GET /forms/{formId}/notifications | FormstackApi2025.ClassicApi | getFormSubmissionsList | GET /forms/{formId}/submissions | FormstackApi2025.ClassicApi | getFormsList | GET /forms | FormstackApi2025.ClassicApi | getNotification | GET /notifications/{notificationId} | FormstackApi2025.ClassicApi | getSubmissionDetails | GET /submissions/{submissionId} | FormstackApi2025.ClassicApi | getSubmissionUpload | GET /submissions/{submissionId}/upload | FormstackApi2025.ClassicApi | getSubmissionsList | GET /submissions | FormstackApi2025.ClassicApi | listFolders | GET /folders | FormstackApi2025.ClassicApi | updateConfirmationEmail | PUT /confirmations/{confirmationId} | FormstackApi2025.ClassicApi | updateNotificationEmail | PUT /notifications/{notificationId} | FormstackApi2025.ConfirmationEmailsApi | createConfirmationEmail | POST /forms/{formId}/confirmations | FormstackApi2025.ConfirmationEmailsApi | deleteConfirmationEmail | DELETE /confirmations/{confirmationId} | FormstackApi2025.ConfirmationEmailsApi | getConfirmation | GET /confirmations/{confirmationId} | FormstackApi2025.ConfirmationEmailsApi | getFormConfirmationEmails | GET /forms/{formId}/confirmations | FormstackApi2025.ConfirmationEmailsApi | updateConfirmationEmail | PUT /confirmations/{confirmationId} | FormstackApi2025.DefaultApi | copyTheme | POST /subaccount/{subaccountId}/theme/{themeId}/copy | FormstackApi2025.DefaultApi | listSubaccounts | GET /subaccount | FormstackApi2025.DefaultApi | subaccountCopyForm | POST /subaccount/{subaccountId}/form/{formId}/copy | FormstackApi2025.FieldsApi | createFieldInForm | POST /forms/{formId}/fields | FormstackApi2025.FieldsApi | deleteField | DELETE /forms/{formId}/fields/{fieldId} | FormstackApi2025.FieldsApi | editField | PUT /forms/{formId}/fields/{fieldId} | FormstackApi2025.FieldsApi | getFieldDetails | GET /forms/{formId}/fields/{fieldId} | FormstackApi2025.FieldsApi | getFormFields | GET /forms/{formId}/fields | FormstackApi2025.FoldersApi | createFolder | POST /folders | FormstackApi2025.FoldersApi | deleteFolder | DELETE /folders/{folderId} | FormstackApi2025.FoldersApi | editFolder | PUT /folders/{folderId} | FormstackApi2025.FoldersApi | getFolder | GET /folders/{folderId} | FormstackApi2025.FoldersApi | listFolders | GET /folders | FormstackApi2025.FormsApi | copyForm | POST /forms/{formId}/copy | FormstackApi2025.FormsApi | createForm | POST /forms | FormstackApi2025.FormsApi | createFormPrefill | POST /forms/{formId}/prefill | FormstackApi2025.FormsApi | deleteForm | DELETE /forms/{formId} | FormstackApi2025.FormsApi | editForm | PUT /forms/{formId} | FormstackApi2025.FormsApi | getFormDetails | GET /forms/{formId} | FormstackApi2025.FormsApi | getFormHtml | GET /forms/{formId}/html | FormstackApi2025.FormsApi | getFormJavascript | GET /forms/{formId}/javascript | FormstackApi2025.FormsApi | getFormsList | GET /forms | FormstackApi2025.NotificationEmailsApi | createNotificationEmail | POST /forms/{formId}/notifications | FormstackApi2025.NotificationEmailsApi | deleteNotificationEmail | DELETE /notifications/{notificationId} | FormstackApi2025.NotificationEmailsApi | getFormNotificationEmails | GET /forms/{formId}/notifications | FormstackApi2025.NotificationEmailsApi | getNotification | GET /notifications/{notificationId} | FormstackApi2025.NotificationEmailsApi | updateNotificationEmail | PUT /notifications/{notificationId} | FormstackApi2025.PartialSubmissionsApi | deletePartialSubmission | DELETE /partialsubmission/{partialSubmissionId} | FormstackApi2025.SmartListApi | deleteSmartList | DELETE /smartlists/{smartListId} | Delete a smart list FormstackApi2025.SmartListApi | getSmartList | GET /smartlists/{smartListId} | Get details of a specific smart list FormstackApi2025.SmartListApi | listSmartLists | GET /smartlists | Get a list of smart lists FormstackApi2025.SmartListOptionsApi | deleteAllSmartListOptions | DELETE /smartlists/{smartListId}/alloptions | Delete all options from a smart list FormstackApi2025.SmartListOptionsApi | deleteSmartListOption | DELETE /smartlists/{smartListId}/options/{optionId} | Delete a smart list option FormstackApi2025.SmartListOptionsApi | deleteSmartListOptionImage | DELETE /smartlists/{smartListId}/options/{optionId}/image | Delete a smart list option's image FormstackApi2025.SmartListOptionsApi | getSmartListOption | GET /smartlists/{smartListId}/options/{optionId} | Get details of a specific smart list option FormstackApi2025.SmartListOptionsApi | listSmartListOptions | GET /smartlists/{smartListId}/options | Get a list of smart list options FormstackApi2025.StreamlineApi | copyForm | POST /forms/{formId}/copy | FormstackApi2025.StreamlineApi | createFieldInForm | POST /forms/{formId}/fields | FormstackApi2025.StreamlineApi | createForm | POST /forms | FormstackApi2025.StreamlineApi | createFormPrefill | POST /forms/{formId}/prefill | FormstackApi2025.StreamlineApi | deleteField | DELETE /forms/{formId}/fields/{fieldId} | FormstackApi2025.StreamlineApi | deleteForm | DELETE /forms/{formId} | FormstackApi2025.StreamlineApi | editField | PUT /forms/{formId}/fields/{fieldId} | FormstackApi2025.StreamlineApi | editForm | PUT /forms/{formId} | FormstackApi2025.StreamlineApi | getFieldDetails | GET /forms/{formId}/fields/{fieldId} | FormstackApi2025.StreamlineApi | getFormDetails | GET /forms/{formId} | FormstackApi2025.StreamlineApi | getFormFields | GET /forms/{formId}/fields | FormstackApi2025.StreamlineApi | getFormsList | GET /forms | FormstackApi2025.SubmissionsApi | countFormSubmissions | GET /forms/{formId}/submissions/count | FormstackApi2025.SubmissionsApi | createSubmission | POST /forms/{formId}/submissions | FormstackApi2025.SubmissionsApi | deleteSubmission | DELETE /submissions/{submissionId} | FormstackApi2025.SubmissionsApi | editSubmission | PUT /submissions/{submissionId} | FormstackApi2025.SubmissionsApi | getFormSubmissionsList | GET /forms/{formId}/submissions | FormstackApi2025.SubmissionsApi | getSubmissionDetails | GET /submissions/{submissionId} | FormstackApi2025.SubmissionsApi | getSubmissionUpload | GET /submissions/{submissionId}/upload | FormstackApi2025.SubmissionsApi | getSubmissionsList | GET /submissions | FormstackApi2025.WebhookApi | createWebhook | POST /forms/{formId}/webhooks | FormstackApi2025.WebhookApi | deleteWebhook | DELETE /forms/{formId}/webhooks/{webhookId} | FormstackApi2025.WebhookApi | getWebhook | GET /forms/{formId}/webhooks/{webhookId} | FormstackApi2025.WebhookApi | getWebhookOpenApi | GET /forms/{formId}/webhooksopenapi | FormstackApi2025.WebhookApi | listWebhooks | GET /forms/{formId}/webhooks | FormstackApi2025.WebhookApi | updateWebhook | PUT /forms/{formId}/webhooks/{webhookId} |

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme