Overview

Namespaces

  • Comprobo
    • Verify
      • Auth
      • Exceptions
      • HTTP

Classes

  • Api
  • Factory
  • State
  • User
  • Workflow
  • Overview
  • Namespace
  • Class

Class Workflow

Workflow service integration

Namespace: Comprobo\Verify
Located at Workflow.php
Methods summary
public
# __construct( Comprobo\Verify\Factory $factory )
public array
# cloneTemplate( string $templateId, string $newFlowName, array $customFields = [] )

Parameters

$templateId
the chosen template ID (uuidv4)
$newFlowName
The name that will appear in Reporting and elsewhere, human readable
$customFields
any merge fields defined by the template.

Returns

array
Service response. It is the caller's responsibility to validate and extract information

See

Comprobo\Verify\Workflow::listTemplates for how to find available templates
Comprobo\Verify\Workflow::getMergeFields for how to fetch available merge fields for a template
public array
# listTemplates( )

Fetch the list of available template types.

Fetch the list of available template types.

Returns

array
The list of results from the service
public array
# getMergeFields( string $templateId )

Retrieve merge fields for the template.

Retrieve merge fields for the template.

When cloning into a usable workflow values for these fields will be interpolated into some content.

Parameters

$templateId
the template you would like merge fields for

Returns

array
list of field ids that can be sent to the cloneTemplate call

See

self::cloneTemplate for how to submit merge field values
public boolean
# assignUser( string $userId, string $templateId )

Assign a user to the workflow.

Assign a user to the workflow.

Parameters

$userId
Comprobo user ID
$templateId
Comprobo template ID

Returns

boolean
API documentation generated by ApiGen