Class FormsApps

Example

const OneBlink = require('@oneblink/sdk')
  const options = {
    accessKey: '123455678901ABCDEFGHIJKL',
    secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
  }
  const formsAppsSDK = new OneBlink.FormsApps(options)
Copy

Create a Forms App

Minimum Role Permission

Apps: Manager

Example

formsAppsSDK.createFormsApp(formsApp).then((savedFormsApp) => {
    // Use Forms App here...
  })
Copy

Create a Forms App User

Minimum Role Permission

App Users: Manager

Example

formsAppsSDK.createUser(formsAppUser).then((savedFormsAppUser) => {
    // Use Forms App User here...
  })
Copy

Delete a Forms App by its identifier

Minimum Role Permission

Apps: Manager

Example

const formsAppId = 1
  formsAppsSDK.deleteFormsApp(formsAppId).then(() => {
    // Forms App has been deleted...
  })
Copy

Remove a custom sending address for a forms app

Minimum Role Permission

App Users: Manager

Example

const formsAppId = 1
  await formsAppsSDK.deleteSendingAddress(formsAppId)
Copy

Delete a Forms App User by its identifier

Minimum Role Permission

App Users: Manager

Example

const formsAppUserId = 1
  formsAppsSDK.deleteUser(formsAppUserId).then(() => {
    // Forms App User has been deleted...
  })
Copy

Get a single Forms App by its identifier

Minimum Role Permission

Apps: Read Only

Example

const formsAppId = 1
  formsAppsSDK.getFormsApp(formsAppId).then((formsApp) => {
    // Use Forms App here...
  })
Copy

Get a single Forms App for the Bearer token of a Forms App User

Example

const bearerToken = ''
  formsAppsSDK.getMyFormsApp(bearerToken).then((formsApp) => {
    // Use Forms App here...
  })
Copy

Get the email address forms app emails will be sent from

Minimum Role Permission

Apps: Read Only

Example

const res = await formsAppsSDK.getSendingAddress(formsAppId)
Copy

Set the email address forms app emails will be sent from

Minimum Role Permission

App Users: Manager

Example

const res = await formsAppsSDK.setSendingAddress(
    formsAppId,
    sendingAddressConfig,
  )
Copy

Update a Forms App

Minimum Role Permission

Apps: Manager

Example

formsAppsSDK.updateFormsApp(formsApp).then((savedFormsApp) => {
    // Use Forms App here...
  })
Copy

A Static function to verify a JWT and return its result

Example

const token =
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
  // or
  const token =
    'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
  OneBlink.FormsApps.verifyJWT(token)
    .then((result) => {
      // Result is Decoded Token
    })
    .catch((e) => {
      // Token was invalid
    })
Copy