Hierarchy

  • default
    • FormsAppEnvironments

Constructors

  • Parameters

    Returns FormsAppEnvironments

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

Methods

  • Minimum Role Permission

    Environments: Manager

    Parameters

    Returns Promise<FormsAppEnvironment>

    const data = {
    name: 'my first environment',
    description: 'Used for development',
    organisationId: 'abc123',
    slug: 'my-env-slug',
    cloneOptions: {
    sourceFormsAppEnvironmentId: 1,
    isCloningFormElementOptionsSets: true,
    isCloningFormElementLookups: true,
    isCloningFormSubmissionEvents: true,
    isCloningFormPostSubmissionActions: true,
    isCloningFormServerValidation: true,
    isCloningFormExternalIdGenerationOnSubmit: true,
    isCloningFormPersonalisation: true,
    },
    }
    const formsAppEnvironment =
    await formsAppEnvironments.createFormsAppEnvironment(data)
    // Use formsAppEnvironment here...
  • Minimum Role Permission

    Environments: Manager

    Parameters

    • formsAppEnvironmentId: number

      The id of the forms app environment to delete

    Returns Promise<void>

    await formsAppEnvironments.deleteFormsAppEnvironment(1)
    
  • Minimum Role Permission

    Environments: Read Only

    Parameters

    • formsAppEnvironmentId: number

      The id of the forms app environment

    Returns Promise<FormsAppEnvironment>

    const formsAppEnvironment =
    await formsAppEnvironments.getFormsAppEnvironment(1)
    // Use data here...
  • Minimum Role Permission

    Environments: Read Only

    Parameters

    Returns Promise<FormsAppEnvironmentsSearchResult>

    const searchParams = {
    limit: 1,
    offset: 0,
    }
    const { formsAppEnvironments, meta } =
    await formsAppEnvironments.searchFormsAppEnvironments(searchParams)
  • Minimum Role Permission

    Environments: Manager

    Parameters

    • OptionalformsAppEnvironment: FormsAppEnvironment

      The data for the forms app environment template to update

    Returns Promise<FormsAppEnvironment>

    const data = {
    name: 'my first environment',
    description: 'Used for development ONLY',
    organisationId: 'abc123',
    slug: 'my-env-slug',
    }
    const formsAppEnvironment =
    await formsAppEnvironments.updateFormsAppEnvironment(data)
    // Use formsAppEnvironment here...