Class FormsAppEnvironments

Hierarchy

default
- FormsAppEnvironments

Index

Constructors

Methods

createFormsAppEnvironment deleteFormsAppEnvironment getFormsAppEnvironment searchFormsAppEnvironments updateFormsAppEnvironment

Constructors

constructor

new FormsAppEnvironments(options: ConstructorOptions): FormsAppEnvironments

Parameters

options: ConstructorOptions

Returns FormsAppEnvironments

Example

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

Methods

createFormsAppEnvironment

createFormsAppEnvironment(
newFormsAppEnvironment: NewFormsAppEnvironment,
): Promise<FormsAppEnvironment>

Minimum Role Permission

Environments: Manager

Parameters

newFormsAppEnvironment: NewFormsAppEnvironment
The data for the new forms app environment

Returns Promise<FormsAppEnvironment>

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

deleteFormsAppEnvironment

deleteFormsAppEnvironment(formsAppEnvironmentId: number): Promise<void>
Minimum Role Permission

Environments: Manager
Parameters
- formsAppEnvironmentId: number
  The id of the forms app environment to delete
Returns Promise<void>
Example
```
await formsAppEnvironments.deleteFormsAppEnvironment(1)
```

getFormsAppEnvironment

getFormsAppEnvironment(
formsAppEnvironmentId: number,
): Promise<FormsAppEnvironment>
Minimum Role Permission

Environments: Read Only
Parameters
- formsAppEnvironmentId: number
  The id of the forms app environment
Returns Promise<FormsAppEnvironment>
Example
```
const formsAppEnvironment =
    await formsAppEnvironments.getFormsAppEnvironment(1)
  // Use data here...
```

searchFormsAppEnvironments

searchFormsAppEnvironments(
searchParams?: BaseSearchOptions,
): Promise<FormsAppEnvironmentsSearchResult>
Minimum Role Permission

Environments: Read Only
Parameters
- OptionalsearchParams: BaseSearchOptions
  Search options
Returns Promise<FormsAppEnvironmentsSearchResult>
Example
```
const searchParams = {
    limit: 1,
    offset: 0,
  }
  const { formsAppEnvironments, meta } =
    await formsAppEnvironments.searchFormsAppEnvironments(searchParams)
```

updateFormsAppEnvironment

updateFormsAppEnvironment(
formsAppEnvironment?: FormsAppEnvironment,
): Promise<FormsAppEnvironment>

Minimum Role Permission

Environments: Manager

Parameters

OptionalformsAppEnvironment: FormsAppEnvironment
The data for the forms app environment template to update

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

Class FormsAppEnvironments

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns FormsAppEnvironments

Example

Methods

createFormsAppEnvironment

Parameters

Returns Promise<FormsAppEnvironment>

Example

deleteFormsAppEnvironment

Parameters

Returns Promise<void>

Example

getFormsAppEnvironment

Parameters

Returns Promise<FormsAppEnvironment>

Example

searchFormsAppEnvironments

Parameters

Returns Promise<FormsAppEnvironmentsSearchResult>

Example

updateFormsAppEnvironment

Parameters

Returns Promise<FormsAppEnvironment>

Example

Settings

On This Page