Hierarchy

  • default
    • Approvals

Constructors

  • Parameters

    Returns Approvals

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

Methods

  • Submission Data Key Supported

    Key must be assigned to the form that was submitted for approval.

    Minimum Role Permission

    Submission Data: Read Only

    Parameters

    • id: number

      The id of the form approval flow instance

    Returns Promise<FormApprovalFlowInstanceResponse>

    const formSubmissionApproval =
    await approvals.getFormApprovalFlowInstance(1)
    // Use data here...
  • Submission Data Key Supported

    Key must be assigned to the form that was submitted for approval.

    Minimum Role Permission

    Submission Data: Read Only

    Parameters

    • id: string

      The id of the form submission approval

    Returns Promise<FormSubmissionApprovalResponse>

    const formSubmissionApproval =
    await approvals.getFormSubmissionApproval(
    'aaaaaaaa-bbbb-4543-cccc-addddd543454',
    )
    // Use data here...
  • Submission Data Key Supported

    Results will be restricted to approvals associated with forms that have been assigned to the Key.

    Minimum Role Permission

    Submission Data: Read Only

    Parameters

    • options: {
          externalId?: string;
          formApprovalFlowInstanceId?: number;
          formId?: number;
          formsAppId: number;
          lastUpdatedBy?: string[];
          limit: number;
          offset: number;
          statuses?: string[];
          submissionId?: string;
          submittedAfterDateTime?: string;
          submittedBeforeDateTime?: string;
          updatedAfterDateTime?: string;
          updatedBeforeDateTime?: string;
      }

      Search options

      • OptionalexternalId?: string

        An exact externalId to search by

      • OptionalformApprovalFlowInstanceId?: number

        The exact formApprovalFlowInstanceId to search by

      • OptionalformId?: number

        The formId of the approvals

      • formsAppId: number

        The formsAppId of the approvals app

      • OptionallastUpdatedBy?: string[]

        An array of usernames to filter by

      • limit: number

        The number of results to return. Maximum is 50

      • offset: number

        The offset of the results to return. Use this in conjunction with limit for pagination

      • Optionalstatuses?: string[]

        An array of statuses to filter by ('PENDING', 'CLARIFICATION_RECEIVED', 'CLARIFICATION_REQUIRED', 'APPROVED', 'CLOSED')

      • OptionalsubmissionId?: string

        An exact submissionId to search by

      • OptionalsubmittedAfterDateTime?: string

        The date submitted after as an ISO string

      • OptionalsubmittedBeforeDateTime?: string

        The date submitted before as an ISO string

      • OptionalupdatedAfterDateTime?: string

        The date updated after as an ISO string

      • OptionalupdatedBeforeDateTime?: string

        The date updated before as an ISO string

    Returns Promise<FormSubmissionsAdministrationApprovalsResponse>

    const { approvals, meta } =
    await approvals.searchFormSubmissionAdministrationApprovals({
    formsAppId: 1,
    formId: 2,
    limit: 50,
    offset: 0,
    })