Hierarchy

  • default
    • FormsAppEnvironments

Constructors

  • Example

    const OneBlink = require('@oneblink/sdk')

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

    Parameters

    Returns FormsAppEnvironments

Methods

  • Example

    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...

    Parameters

    Returns Promise<FormsAppEnvironment>

  • Example

    await formsAppEnvironments.deleteEmailTemplate(1)
    

    Parameters

    • formsAppEnvironmentId: number

    Returns Promise<void>

  • Example

    const formsAppEnvironment =
    await formsAppEnvironments.getFormsAppEnvironment(1)
    // Use data here...

    Parameters

    • formsAppEnvironmentId: number

    Returns Promise<FormsAppEnvironment>

  • Example

    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...

    Parameters

    • Optional formsAppEnvironment: FormsAppEnvironment

      The data for the forms app environment template to update

    Returns Promise<FormsAppEnvironment>