/** * Fireblocks API * Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain. - Visit our website for more information: [Fireblocks Website](https://fireblocks.com) - Visit our developer docs: [Fireblocks DevPortal](https://developers.fireblocks.com) * * The version of the OpenAPI document: 1.6.2 * Contact: developers@fireblocks.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import { RuleSet } from './rule-set'; import { ScreeningOperationEnum } from './screening-operation-enum'; /** * Configuration for one operation the step\'s connector handles. The operation arrives on the screening request; the connector decides how to handle it. Two rule sets govern the step, and both are configured here rather than sent per request, so the same call behaves differently across workflows. Trigger rules decide whether the connector runs at all; outcome rules turn the provider\'s response into the step\'s verdict. With neither configured the step runs under the connector\'s own defaults, which for `kyt_trmlabs` are permissive: the screening completes without consulting the provider. The four parameter lists are the contract for writing those rules: a rule naming a field outside `triggerRuleParameters` or `outcomeEvaluationParameters` is rejected. They are derived from the connector registry rather than stored, so a connector gaining a field is reflected here without a migration. * @export * @interface StepOperationConfig */ export interface StepOperationConfig { /** * * @type {ScreeningOperationEnum} * @memberof StepOperationConfig */ 'operation'?: ScreeningOperationEnum; /** * Resolved server-side on every `GetWorkflow` call from the step\'s connector definition for this operation. Read-only: ignored on write. * @type {Array} * @memberof StepOperationConfig */ 'requiredParameters'?: Array; /** * Like `requiredParameters`, but optional inputs to the operation. * @type {Array} * @memberof StepOperationConfig */ 'optionalParameters'?: Array; /** * Fields a condition in `triggerRuleSetStruct` may reference. * @type {Array} * @memberof StepOperationConfig */ 'triggerRuleParameters'?: Array; /** * Provider response fields a condition in `outcomeRuleSetStruct` may reference. * @type {Array} * @memberof StepOperationConfig */ 'outcomeEvaluationParameters'?: Array; /** * Additional provider response fields returned with the result; not usable in `outcomeRuleSetStruct` conditions. * @type {Array} * @memberof StepOperationConfig */ 'outcomeMetaParameters'?: Array; /** * * @type {RuleSet} * @memberof StepOperationConfig */ 'triggerRuleSetStruct'?: RuleSet; /** * The tenant\'s trigger rules, as a JSON-encoded string. Set for steps whose rules are still defined as a legacy screening policy rather than natively in Compliance Orchestrator, and refreshed on every read. Mutually exclusive with `triggerRuleSetStruct`. * @type {string} * @memberof StepOperationConfig */ 'triggerRuleSetJson'?: string | null; /** * * @type {RuleSet} * @memberof StepOperationConfig */ 'outcomeRuleSetStruct'?: RuleSet; /** * The tenant\'s outcome rules, as a JSON-encoded string. Set for steps whose rules are still defined as a legacy screening policy rather than natively in Compliance Orchestrator, and refreshed on every read. Mutually exclusive with `outcomeRuleSetStruct`. * @type {string} * @memberof StepOperationConfig */ 'outcomeRuleSetJson'?: string | null; }