> ## Documentation Index > Fetch the complete documentation index at: https://doc.extole.com/llms.txt > Use this file to discover all available pages before exploring further. # Get a built campaign > Returns the specified campaign version in its fully evaluated (built) runtime form, with all evaluatable fields resolved against current component and setting values. Omit the `/version/{version}` segment to retrieve the built form of the latest version. ## OpenAPI ````yaml /api-reference/management.json get /v2/campaigns/{campaignId}{version}/built openapi: 3.0.1 info: description: >- Configuration endpoints for the Extole platform: campaigns, components, audiences, persons, rewards, reporting, integrations setup, and administrative tooling. title: Management API version: '1.0' servers: - description: Production url: https://api.extole.io security: - HEADER: [] - QUERY: [] - COOKIE: [] tags: - name: Audiences - name: Authentication - name: Batch Jobs - name: Blocks - name: Campaigns - name: Components - name: Components Settings - name: Domains - name: Email - name: Erasure - name: Event Streams - name: File Validation Monitors - name: Optout - name: Profiles - name: Promotion Links - name: Report Schedules - name: Report Types - name: Reports - name: Reward Suppliers - name: Security Keys - name: Settings - name: User Notifications - name: User Subscriptions - name: Users - name: Webhooks paths: /v2/campaigns/{campaignId}{version}/built: get: tags: - Campaigns summary: Get a built campaign description: >- Returns the specified campaign version in its fully evaluated (built) runtime form, with all evaluatable fields resolved against current component and setting values. Omit the `/version/{version}` segment to retrieve the built form of the latest version. operationId: getBuiltCampaign parameters: - in: path name: campaignId required: true schema: type: string - in: path name: version required: true schema: pattern: (/version/.+)? type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/BuiltCampaignResponse' description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' campaign_build_failed: $ref: '#/components/examples/campaign_build_failed' campaign_concurrent_update: $ref: '#/components/examples/campaign_concurrent_update' campaign_has_pending_changes: $ref: '#/components/examples/campaign_has_pending_changes' campaign_locked: $ref: '#/components/examples/campaign_locked' campaign_version_malformed: $ref: '#/components/examples/campaign_version_malformed' controller_state_misconfiguration: $ref: '#/components/examples/controller_state_misconfiguration' date_invalid: $ref: '#/components/examples/date_invalid' expression_invalid_syntax: $ref: '#/components/examples/expression_invalid_syntax' invalid_campaign_id: $ref: '#/components/examples/invalid_campaign_id' invalid_campaign_state: $ref: '#/components/examples/invalid_campaign_state' invalid_campaign_version: $ref: '#/components/examples/invalid_campaign_version' invalid_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' lock_missing_lock_types: $ref: '#/components/examples/lock_missing_lock_types' missing_request_body: $ref: '#/components/examples/missing_request_body' rebuild_campaigns_build_failed: $ref: '#/components/examples/rebuild_campaigns_build_failed' unlock_missing_lock_types: $ref: '#/components/examples/unlock_missing_lock_types' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '401': content: application/json: examples: method_unauthorized: $ref: '#/components/examples/method_unauthorized' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unauthorized '402': content: application/json: examples: payment_required: $ref: '#/components/examples/payment_required' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Payment Required '403': content: application/json: examples: access_denied: $ref: '#/components/examples/access_denied' method_unauthorized: $ref: '#/components/examples/method_unauthorized' missing_access_token: $ref: '#/components/examples/missing_access_token' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Forbidden '415': content: application/json: examples: unsupported_media_type: $ref: '#/components/examples/unsupported_media_type' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unsupported Media Type '429': content: application/json: examples: too_many_requests: $ref: '#/components/examples/too_many_requests' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Too Many Requests components: schemas: BuiltCampaignResponse: description: >- campaign after buildtime evaluation. Fields `variant_selector` and `variants` are already evaluated. properties: campaign_id: type: string campaign_locks: items: enum: - DUPLICATE - EDIT type: string type: array uniqueItems: true campaign_type: enum: - CONFIGURATION - EXTENSION - INTEGRATION - MARKETING type: string components: items: $ref: '#/components/schemas/BuiltCampaignComponentResponse' type: array description: type: string end_date: $ref: '#/components/schemas/ZonedDateTime' flow_steps: items: $ref: '#/components/schemas/BuiltCampaignFlowStepResponse' type: array incentive: $ref: '#/components/schemas/IncentiveResponse' incentive_id: type: string is_published: type: boolean labels: items: $ref: '#/components/schemas/CampaignLabelResponse' type: array last_published_date: $ref: '#/components/schemas/ZonedDateTime' name: type: string parent_version: format: int32 type: integer pause_date: $ref: '#/components/schemas/ZonedDateTime' program_label: type: string program_type: type: string start_date: $ref: '#/components/schemas/ZonedDateTime' state: enum: - ARCHIVED - ENDED - LIVE - NOT_LAUNCHED - PAUSED - STOPPED type: string steps: items: $ref: '#/components/schemas/BuiltCampaignStepResponse' type: array stop_date: $ref: '#/components/schemas/ZonedDateTime' tags: items: type: string type: array uniqueItems: true theme_name: type: string updated_date: $ref: '#/components/schemas/ZonedDateTime' variant_selector: $ref: '#/components/schemas/VariantSelectorInBuiltCampaignResponse' variants: items: type: string type: array version: format: int32 type: integer required: - campaign_id - campaign_locks - campaign_type - components - description - end_date - flow_steps - incentive - incentive_id - is_published - labels - last_published_date - name - parent_version - pause_date - program_label - program_type - start_date - state - steps - stop_date - tags - theme_name - updated_date - variant_selector - variants - version type: object RestExceptionResponse: description: Represents the API error response properties: code: description: Specific error code for this error type, documented per endpoint type: string http_status_code: description: >- HTTP status code that was returned with this error, useful if client get response code format: int32 type: integer message: description: User readable English description of the error type: string parameters: additionalProperties: description: >- Attributes related to the error, varies be error code, documented per endpoint type: object description: >- Attributes related to the error, varies be error code, documented per endpoint type: object unique_id: description: >- Unique id associated with this error, useful for discussions with Extole type: string required: - code - http_status_code - message - parameters - unique_id type: object BuiltCampaignComponentResponse: properties: assets: items: $ref: '#/components/schemas/BuiltComponentAssetResponse' type: array component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceResponse' type: array created_date: $ref: '#/components/schemas/ZonedDateTime' description: type: string display_name: type: string facets: items: $ref: '#/components/schemas/CampaignComponentFacetResponse' type: array id: readOnly: true type: string install: $ref: '#/components/schemas/InstallInBuiltCampaignComponentResponse' installed_into_socket: type: string name: type: string origin: $ref: '#/components/schemas/ComponentOriginResponse' tags: items: type: string type: array uniqueItems: true type: type: string types: items: type: string type: array updated_date: $ref: '#/components/schemas/ZonedDateTime' upload_version: type: string variables: items: $ref: '#/components/schemas/BuiltCampaignComponentSettingResponse' type: array version: format: int32 type: integer required: - assets - component_ids - component_references - created_date - description - display_name - facets - id - install - installed_into_socket - name - origin - tags - type - types - updated_date - upload_version - variables - version type: object ZonedDateTime: description: >- [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds. example: '2025-10-24T02:00:00-07:00' pattern: >- ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$ type: string BuiltCampaignFlowStepResponse: properties: apps: items: $ref: '#/components/schemas/BuiltCampaignFlowStepAppResponse' type: array component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceResponse' type: array description: type: string flow_path: type: string flow_step_id: type: string icon_color: type: string icon_type: type: string metrics: items: $ref: '#/components/schemas/BuiltCampaignFlowStepMetricResponse' type: array name: type: string sequence: type: number step_name: type: string tags: items: type: string type: array uniqueItems: true words: $ref: '#/components/schemas/BuiltCampaignFlowStepWordsResponse' required: - apps - component_ids - component_references - description - flow_path - flow_step_id - icon_color - icon_type - metrics - name - sequence - step_name - tags - words type: object IncentiveResponse: properties: id: readOnly: true type: string quality_rules: items: $ref: '#/components/schemas/QualityRuleResponse' type: array reward_rules: items: $ref: '#/components/schemas/RewardRuleResponse' type: array transition_rules: items: $ref: '#/components/schemas/TransitionRuleResponse' type: array required: - id - quality_rules - reward_rules - transition_rules type: object CampaignLabelResponse: properties: name: type: string type: enum: - DATA - PROGRAM type: string type: object BuiltCampaignStepResponse: discriminator: mapping: CONTROLLER: $ref: '#/components/schemas/BuiltCampaignControllerResponse' FRONTEND_CONTROLLER: $ref: '#/components/schemas/BuiltCampaignFrontendControllerResponse' JOURNEY_ENTRY: $ref: '#/components/schemas/BuiltCampaignJourneyEntryResponse' propertyName: type oneOf: - title: CONTROLLER allOf: - $ref: '#/components/schemas/BuiltCampaignControllerResponse' - title: FRONTEND_CONTROLLER allOf: - $ref: '#/components/schemas/BuiltCampaignFrontendControllerResponse' - title: JOURNEY_ENTRY allOf: - $ref: '#/components/schemas/BuiltCampaignJourneyEntryResponse' required: - component_ids - component_references - created_date - data - enabled - id - step_builder - triggers - type - updated_date VariantSelectorInBuiltCampaignResponse: description: >- The variant selector as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@runtime:.* type: string - pattern: ^javascript@runtime:.* type: string type: string description: Literal variant selector title: Static Value - description: >- Handlebars expression with [VariantSelectionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/VariantSelectionContext.d.ts). example: handlebars@runtime:{{variantSelector}} externalDocs: description: VariantSelectionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/VariantSelectionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [VariantSelectionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/VariantSelectionContext.d.ts). example: >- javascript@runtime:function() { return context.get('variantSelector');} externalDocs: description: VariantSelectionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/VariantSelectionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string BuiltComponentAssetResponse: properties: description: type: string filename: type: string id: readOnly: true type: string name: type: string tags: items: type: string type: array uniqueItems: true required: - description - filename - id - name - tags type: object ComponentReferenceResponse: properties: component_id: type: string socket_names: items: type: string type: array type: object CampaignComponentFacetResponse: properties: name: type: string value: type: string type: object InstallInBuiltCampaignComponentResponse: description: >- The install as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal install title: Static Value type: object - description: >- Handlebars expression with [ComponentInstalltimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/component/install/ComponentInstalltimeContext.d.ts). example: handlebars@installtime:{{install}} externalDocs: description: ComponentInstalltimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/component/install/ComponentInstalltimeContext.d.ts pattern: ^handlebars@installtime:.* title: Installtime - Handlebars type: string - description: >- Javascript expression with [ComponentInstalltimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/component/install/ComponentInstalltimeContext.d.ts). example: >- javascript@installtime:function() { return context.getVariableContext().get('install');} externalDocs: description: ComponentInstalltimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/component/install/ComponentInstalltimeContext.d.ts pattern: ^javascript@installtime:.* title: Installtime - Javascript type: string ComponentOriginResponse: properties: client_id: type: string component_id: type: string component_version: format: int32 type: integer type: object BuiltCampaignComponentSettingResponse: discriminator: mapping: ADMIN_ICON: $ref: >- #/components/schemas/BuiltCampaignComponentVariableResponseAsAdminIcon AUDIENCE_ID: $ref: >- #/components/schemas/BuiltCampaignComponentVariableResponseAsAudienceId AUDIENCE_ID_LIST: $ref: >- #/components/schemas/BuiltCampaignComponentVariableResponseAsAudienceIdList BOOLEAN: $ref: >- #/components/schemas/BuiltCampaignComponentVariableResponseAsBoolean BROWSER_SIDE_JAVASCRIPT: $ref: >- #/components/schemas/BuiltCampaignComponentVariableResponseAsBrowserSideJavascript CLIENT_DOMAIN_ID_LIST: $ref: >- #/components/schemas/BuiltCampaignComponentVariableResponseAsClientDomainIdList CLIENT_KEY: $ref: >- #/components/schemas/BuiltCampaignComponentVariableResponseAsClientKey CLIENT_KEY_FLOW: $ref: '#/components/schemas/BuiltComponentClientKeyFlowVariableResponse' COLOR: $ref: '#/components/schemas/BuiltCampaignComponentVariableResponseAsColor' COMPONENT_ID: $ref: '#/components/schemas/BuiltComponentComponentIdVariableResponse' COMPONENT_SETTING_LOOKUP: $ref: >- #/components/schemas/BuiltComponentComponentSettingLookupVariableResponse CSS: $ref: '#/components/schemas/BuiltCampaignComponentVariableResponseAsCss' DELAY: $ref: '#/components/schemas/BuiltCampaignComponentVariableResponseAsDelay' DELAY_LIST: $ref: >- #/components/schemas/BuiltCampaignComponentVariableResponseAsDelayList ENUM: $ref: '#/components/schemas/BuiltComponentEnumVariableResponse' ENUM_LIST: $ref: '#/components/schemas/BuiltComponentEnumListVariableResponse' EXTOLE_CLIENT_KEY: $ref: >- #/components/schemas/BuiltCampaignComponentVariableResponseAsExtoleClientKey FONT: $ref: '#/components/schemas/BuiltCampaignComponentVariableResponseAsFont' GLOB_COMPONENT_PATH: $ref: >- #/components/schemas/BuiltCampaignComponentVariableResponseAsGlobComponentPath HTML: $ref: '#/components/schemas/BuiltCampaignComponentVariableResponseAsHtml' IMAGE: $ref: '#/components/schemas/BuiltCampaignComponentVariableResponseAsImage' INTEGER: $ref: >- #/components/schemas/BuiltCampaignComponentVariableResponseAsInteger INTEGER_LIST: $ref: >- #/components/schemas/BuiltCampaignComponentVariableResponseAsIntegerList JSON: $ref: '#/components/schemas/BuiltCampaignComponentVariableResponseAsJson' MULTI_SOCKET: $ref: '#/components/schemas/BuiltComponentSocketResponseAsMultiSocket' PARTNER_ENUM: $ref: '#/components/schemas/BuiltComponentPartnerEnumVariableResponse' PARTNER_ENUM_LIST: $ref: '#/components/schemas/BuiltComponentPartnerEnumListVariableResponse' PERSON_KEY_NAME: $ref: >- #/components/schemas/BuiltCampaignComponentVariableResponseAsPersonKeyName REWARD_SUPPLIER_ID: $ref: >- #/components/schemas/BuiltCampaignComponentVariableResponseAsRewardSupplierId REWARD_SUPPLIER_ID_LIST: $ref: >- #/components/schemas/BuiltComponentRewardSupplierIdListVariableResponse SOCKET: $ref: '#/components/schemas/BuiltComponentSocketResponseAsSocket' STRING: $ref: >- #/components/schemas/BuiltCampaignComponentVariableResponseAsString STRING_LIST: $ref: >- #/components/schemas/BuiltCampaignComponentVariableResponseAsStringList STRING_MAP: $ref: '#/components/schemas/BuiltComponentStringMapVariableResponse' URL: $ref: '#/components/schemas/BuiltCampaignComponentVariableResponseAsUrl' WEBHOOK_ID: $ref: >- #/components/schemas/BuiltCampaignComponentVariableResponseAsWebhookId propertyName: type oneOf: - title: ADMIN_ICON allOf: - $ref: >- #/components/schemas/BuiltCampaignComponentVariableResponseAsAdminIcon - title: AUDIENCE_ID allOf: - $ref: >- #/components/schemas/BuiltCampaignComponentVariableResponseAsAudienceId - title: AUDIENCE_ID_LIST allOf: - $ref: >- #/components/schemas/BuiltCampaignComponentVariableResponseAsAudienceIdList - title: BOOLEAN allOf: - $ref: >- #/components/schemas/BuiltCampaignComponentVariableResponseAsBoolean - title: BROWSER_SIDE_JAVASCRIPT allOf: - $ref: >- #/components/schemas/BuiltCampaignComponentVariableResponseAsBrowserSideJavascript - title: CLIENT_DOMAIN_ID_LIST allOf: - $ref: >- #/components/schemas/BuiltCampaignComponentVariableResponseAsClientDomainIdList - title: CLIENT_KEY allOf: - $ref: >- #/components/schemas/BuiltCampaignComponentVariableResponseAsClientKey - title: CLIENT_KEY_FLOW allOf: - $ref: '#/components/schemas/BuiltComponentClientKeyFlowVariableResponse' - title: COLOR allOf: - $ref: >- #/components/schemas/BuiltCampaignComponentVariableResponseAsColor - title: COMPONENT_ID allOf: - $ref: '#/components/schemas/BuiltComponentComponentIdVariableResponse' - title: COMPONENT_SETTING_LOOKUP allOf: - $ref: >- #/components/schemas/BuiltComponentComponentSettingLookupVariableResponse - title: CSS allOf: - $ref: '#/components/schemas/BuiltCampaignComponentVariableResponseAsCss' - title: DELAY allOf: - $ref: >- #/components/schemas/BuiltCampaignComponentVariableResponseAsDelay - title: DELAY_LIST allOf: - $ref: >- #/components/schemas/BuiltCampaignComponentVariableResponseAsDelayList - title: ENUM allOf: - $ref: '#/components/schemas/BuiltComponentEnumVariableResponse' - title: ENUM_LIST allOf: - $ref: '#/components/schemas/BuiltComponentEnumListVariableResponse' - title: EXTOLE_CLIENT_KEY allOf: - $ref: >- #/components/schemas/BuiltCampaignComponentVariableResponseAsExtoleClientKey - title: FONT allOf: - $ref: >- #/components/schemas/BuiltCampaignComponentVariableResponseAsFont - title: GLOB_COMPONENT_PATH allOf: - $ref: >- #/components/schemas/BuiltCampaignComponentVariableResponseAsGlobComponentPath - title: HTML allOf: - $ref: >- #/components/schemas/BuiltCampaignComponentVariableResponseAsHtml - title: IMAGE allOf: - $ref: >- #/components/schemas/BuiltCampaignComponentVariableResponseAsImage - title: INTEGER allOf: - $ref: >- #/components/schemas/BuiltCampaignComponentVariableResponseAsInteger - title: INTEGER_LIST allOf: - $ref: >- #/components/schemas/BuiltCampaignComponentVariableResponseAsIntegerList - title: JSON allOf: - $ref: >- #/components/schemas/BuiltCampaignComponentVariableResponseAsJson - title: MULTI_SOCKET allOf: - $ref: '#/components/schemas/BuiltComponentSocketResponseAsMultiSocket' - title: PARTNER_ENUM allOf: - $ref: '#/components/schemas/BuiltComponentPartnerEnumVariableResponse' - title: PARTNER_ENUM_LIST allOf: - $ref: >- #/components/schemas/BuiltComponentPartnerEnumListVariableResponse - title: PERSON_KEY_NAME allOf: - $ref: >- #/components/schemas/BuiltCampaignComponentVariableResponseAsPersonKeyName - title: REWARD_SUPPLIER_ID allOf: - $ref: >- #/components/schemas/BuiltCampaignComponentVariableResponseAsRewardSupplierId - title: REWARD_SUPPLIER_ID_LIST allOf: - $ref: >- #/components/schemas/BuiltComponentRewardSupplierIdListVariableResponse - title: SOCKET allOf: - $ref: '#/components/schemas/BuiltComponentSocketResponseAsSocket' - title: STRING allOf: - $ref: >- #/components/schemas/BuiltCampaignComponentVariableResponseAsString - title: STRING_LIST allOf: - $ref: >- #/components/schemas/BuiltCampaignComponentVariableResponseAsStringList - title: STRING_MAP allOf: - $ref: '#/components/schemas/BuiltComponentStringMapVariableResponse' - title: URL allOf: - $ref: '#/components/schemas/BuiltCampaignComponentVariableResponseAsUrl' - title: WEBHOOK_ID allOf: - $ref: >- #/components/schemas/BuiltCampaignComponentVariableResponseAsWebhookId required: - display_name - name - priority - tags - type - values BuiltCampaignFlowStepAppResponse: properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceResponse' type: array description: type: string name: type: string type: $ref: '#/components/schemas/BuiltCampaignFlowStepAppTypeResponse' required: - component_ids - component_references - description - name - type type: object BuiltCampaignFlowStepMetricResponse: properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceResponse' type: array description: nullable: true type: string expression: type: string id: readOnly: true type: string name: type: string tags: items: type: string type: array uniqueItems: true unit: type: string required: - component_ids - component_references - description - expression - id - name - tags - unit type: object BuiltCampaignFlowStepWordsResponse: properties: person_counting_name: type: string plural_noun_name: type: string rate_name: type: string singular_noun_name: type: string verb_name: type: string type: object QualityRuleResponse: properties: action_types: items: enum: - ANY_CLICK - ANY_PROMOTION - ANY_PURCHASE - ANY_REGISTER - ANY_SHARE - ANY_SHARE_REWARD - GENERIC_ACTION_1 - GENERIC_ACTION_10 - GENERIC_ACTION_100 - GENERIC_ACTION_101 - GENERIC_ACTION_102 - GENERIC_ACTION_103 - GENERIC_ACTION_104 - GENERIC_ACTION_105 - GENERIC_ACTION_106 - GENERIC_ACTION_107 - GENERIC_ACTION_108 - GENERIC_ACTION_109 - GENERIC_ACTION_11 - GENERIC_ACTION_110 - GENERIC_ACTION_111 - GENERIC_ACTION_112 - GENERIC_ACTION_113 - GENERIC_ACTION_114 - GENERIC_ACTION_115 - GENERIC_ACTION_116 - GENERIC_ACTION_117 - GENERIC_ACTION_118 - GENERIC_ACTION_119 - GENERIC_ACTION_12 - GENERIC_ACTION_120 - GENERIC_ACTION_121 - GENERIC_ACTION_122 - GENERIC_ACTION_123 - GENERIC_ACTION_124 - GENERIC_ACTION_125 - GENERIC_ACTION_126 - GENERIC_ACTION_127 - GENERIC_ACTION_128 - GENERIC_ACTION_129 - GENERIC_ACTION_13 - GENERIC_ACTION_130 - GENERIC_ACTION_131 - GENERIC_ACTION_132 - GENERIC_ACTION_133 - GENERIC_ACTION_134 - GENERIC_ACTION_135 - GENERIC_ACTION_136 - GENERIC_ACTION_137 - GENERIC_ACTION_138 - GENERIC_ACTION_139 - GENERIC_ACTION_14 - GENERIC_ACTION_140 - GENERIC_ACTION_141 - GENERIC_ACTION_142 - GENERIC_ACTION_143 - GENERIC_ACTION_144 - GENERIC_ACTION_145 - GENERIC_ACTION_146 - GENERIC_ACTION_147 - GENERIC_ACTION_148 - GENERIC_ACTION_149 - GENERIC_ACTION_15 - GENERIC_ACTION_150 - GENERIC_ACTION_151 - GENERIC_ACTION_152 - GENERIC_ACTION_153 - GENERIC_ACTION_154 - GENERIC_ACTION_155 - GENERIC_ACTION_156 - GENERIC_ACTION_157 - GENERIC_ACTION_158 - GENERIC_ACTION_159 - GENERIC_ACTION_16 - GENERIC_ACTION_160 - GENERIC_ACTION_161 - GENERIC_ACTION_162 - GENERIC_ACTION_163 - GENERIC_ACTION_164 - GENERIC_ACTION_165 - GENERIC_ACTION_166 - GENERIC_ACTION_167 - GENERIC_ACTION_168 - GENERIC_ACTION_169 - GENERIC_ACTION_17 - GENERIC_ACTION_170 - GENERIC_ACTION_171 - GENERIC_ACTION_172 - GENERIC_ACTION_173 - GENERIC_ACTION_174 - GENERIC_ACTION_175 - GENERIC_ACTION_176 - GENERIC_ACTION_177 - GENERIC_ACTION_178 - GENERIC_ACTION_179 - GENERIC_ACTION_18 - GENERIC_ACTION_180 - GENERIC_ACTION_181 - GENERIC_ACTION_182 - GENERIC_ACTION_183 - GENERIC_ACTION_184 - GENERIC_ACTION_185 - GENERIC_ACTION_186 - GENERIC_ACTION_187 - GENERIC_ACTION_188 - GENERIC_ACTION_189 - GENERIC_ACTION_19 - GENERIC_ACTION_190 - GENERIC_ACTION_191 - GENERIC_ACTION_192 - GENERIC_ACTION_193 - GENERIC_ACTION_194 - GENERIC_ACTION_195 - GENERIC_ACTION_196 - GENERIC_ACTION_197 - GENERIC_ACTION_198 - GENERIC_ACTION_199 - GENERIC_ACTION_2 - GENERIC_ACTION_20 - GENERIC_ACTION_200 - GENERIC_ACTION_21 - GENERIC_ACTION_22 - GENERIC_ACTION_23 - GENERIC_ACTION_24 - GENERIC_ACTION_25 - GENERIC_ACTION_26 - GENERIC_ACTION_27 - GENERIC_ACTION_28 - GENERIC_ACTION_29 - GENERIC_ACTION_3 - GENERIC_ACTION_30 - GENERIC_ACTION_31 - GENERIC_ACTION_32 - GENERIC_ACTION_33 - GENERIC_ACTION_34 - GENERIC_ACTION_35 - GENERIC_ACTION_36 - GENERIC_ACTION_37 - GENERIC_ACTION_38 - GENERIC_ACTION_39 - GENERIC_ACTION_4 - GENERIC_ACTION_40 - GENERIC_ACTION_41 - GENERIC_ACTION_42 - GENERIC_ACTION_43 - GENERIC_ACTION_44 - GENERIC_ACTION_45 - GENERIC_ACTION_46 - GENERIC_ACTION_47 - GENERIC_ACTION_48 - GENERIC_ACTION_49 - GENERIC_ACTION_5 - GENERIC_ACTION_50 - GENERIC_ACTION_51 - GENERIC_ACTION_52 - GENERIC_ACTION_53 - GENERIC_ACTION_54 - GENERIC_ACTION_55 - GENERIC_ACTION_56 - GENERIC_ACTION_57 - GENERIC_ACTION_58 - GENERIC_ACTION_59 - GENERIC_ACTION_6 - GENERIC_ACTION_60 - GENERIC_ACTION_61 - GENERIC_ACTION_62 - GENERIC_ACTION_63 - GENERIC_ACTION_64 - GENERIC_ACTION_65 - GENERIC_ACTION_66 - GENERIC_ACTION_67 - GENERIC_ACTION_68 - GENERIC_ACTION_69 - GENERIC_ACTION_7 - GENERIC_ACTION_70 - GENERIC_ACTION_71 - GENERIC_ACTION_72 - GENERIC_ACTION_73 - GENERIC_ACTION_74 - GENERIC_ACTION_75 - GENERIC_ACTION_76 - GENERIC_ACTION_77 - GENERIC_ACTION_78 - GENERIC_ACTION_79 - GENERIC_ACTION_8 - GENERIC_ACTION_80 - GENERIC_ACTION_81 - GENERIC_ACTION_82 - GENERIC_ACTION_83 - GENERIC_ACTION_84 - GENERIC_ACTION_85 - GENERIC_ACTION_86 - GENERIC_ACTION_87 - GENERIC_ACTION_88 - GENERIC_ACTION_89 - GENERIC_ACTION_9 - GENERIC_ACTION_90 - GENERIC_ACTION_91 - GENERIC_ACTION_92 - GENERIC_ACTION_93 - GENERIC_ACTION_94 - GENERIC_ACTION_95 - GENERIC_ACTION_96 - GENERIC_ACTION_97 - GENERIC_ACTION_98 - GENERIC_ACTION_99 - THEME_GENERIC_ACTION_1 - THEME_GENERIC_ACTION_10 - THEME_GENERIC_ACTION_11 - THEME_GENERIC_ACTION_12 - THEME_GENERIC_ACTION_13 - THEME_GENERIC_ACTION_14 - THEME_GENERIC_ACTION_15 - THEME_GENERIC_ACTION_16 - THEME_GENERIC_ACTION_17 - THEME_GENERIC_ACTION_18 - THEME_GENERIC_ACTION_19 - THEME_GENERIC_ACTION_2 - THEME_GENERIC_ACTION_20 - THEME_GENERIC_ACTION_21 - THEME_GENERIC_ACTION_22 - THEME_GENERIC_ACTION_23 - THEME_GENERIC_ACTION_24 - THEME_GENERIC_ACTION_25 - THEME_GENERIC_ACTION_26 - THEME_GENERIC_ACTION_27 - THEME_GENERIC_ACTION_28 - THEME_GENERIC_ACTION_29 - THEME_GENERIC_ACTION_3 - THEME_GENERIC_ACTION_30 - THEME_GENERIC_ACTION_4 - THEME_GENERIC_ACTION_5 - THEME_GENERIC_ACTION_6 - THEME_GENERIC_ACTION_7 - THEME_GENERIC_ACTION_8 - THEME_GENERIC_ACTION_9 type: string type: array uniqueItems: true enabled: type: boolean id: readOnly: true type: string properties: additionalProperties: items: type: string type: array type: object rule_type: enum: - BAD_COUNTRY - BLACKLIST_DOMAIN - BLACKLIST_REFERER_HEADER - BLOCKED - BOT_FILTER - EVENT_SPEED - EXISTING_CUSTOMER - FRIENDS_OF_ADVOCATE_CLICK_LIMIT - FRIENDS_OF_ADVOCATE_CONVERSION_LIMIT - FRIENDS_OF_ADVOCATE_REGISTRATION_LIMIT - GENERIC - GLOBAL_BLOCK - IP_FILTER - PERSON_DATA - PREVIEW - PROFILE_DISPLACED - RECENT_CUSTOMER - RECIPIENT_LIMIT - REFERRAL_AGE - REFERRAL_CAP - SAME_IP - SELF_REFERRAL - SHARE_COUNT_LIMIT - SIMILAR_FRIEND_ADVOCATE_EMAIL - SPAM_MESSAGE - VALID_EMAIL type: string required: - action_types - enabled - id - properties - rule_type type: object RewardRuleResponse: properties: count_rewards_based_on_partner_user_id: nullable: true type: boolean data_attribute_matcher_type: enum: - EXACT - REGEX nullable: true type: string data_attribute_name: nullable: true type: string data_attribute_value: nullable: true type: string expression: $ref: '#/components/schemas/RewardRuleExpression' id: readOnly: true type: string is_email_required: type: boolean is_referral_loop_allowed: type: boolean is_unique_friend_required: type: boolean min_cart_value: type: number referrals_per_reward: format: int32 type: integer reward_count_limit: format: int32 type: integer reward_count_since_days: format: int32 nullable: true type: integer reward_count_since_month: format: int32 nullable: true type: integer reward_every_x_friend_actions: format: int32 nullable: true type: integer reward_slots: items: type: string type: array uniqueItems: true reward_supplier_id: type: string reward_value_limit: type: number reward_value_since_days: format: int32 nullable: true type: integer reward_value_since_month: format: int32 nullable: true type: integer rewardee: enum: - ADVOCATE - FRIEND type: string trigger_action_type: enum: - ANY_CLICK - ANY_PROMOTION - ANY_PURCHASE - ANY_REGISTER - ANY_SHARE - ANY_SHARE_REWARD - GENERIC_ACTION_1 - GENERIC_ACTION_10 - GENERIC_ACTION_100 - GENERIC_ACTION_101 - GENERIC_ACTION_102 - GENERIC_ACTION_103 - GENERIC_ACTION_104 - GENERIC_ACTION_105 - GENERIC_ACTION_106 - GENERIC_ACTION_107 - GENERIC_ACTION_108 - GENERIC_ACTION_109 - GENERIC_ACTION_11 - GENERIC_ACTION_110 - GENERIC_ACTION_111 - GENERIC_ACTION_112 - GENERIC_ACTION_113 - GENERIC_ACTION_114 - GENERIC_ACTION_115 - GENERIC_ACTION_116 - GENERIC_ACTION_117 - GENERIC_ACTION_118 - GENERIC_ACTION_119 - GENERIC_ACTION_12 - GENERIC_ACTION_120 - GENERIC_ACTION_121 - GENERIC_ACTION_122 - GENERIC_ACTION_123 - GENERIC_ACTION_124 - GENERIC_ACTION_125 - GENERIC_ACTION_126 - GENERIC_ACTION_127 - GENERIC_ACTION_128 - GENERIC_ACTION_129 - GENERIC_ACTION_13 - GENERIC_ACTION_130 - GENERIC_ACTION_131 - GENERIC_ACTION_132 - GENERIC_ACTION_133 - GENERIC_ACTION_134 - GENERIC_ACTION_135 - GENERIC_ACTION_136 - GENERIC_ACTION_137 - GENERIC_ACTION_138 - GENERIC_ACTION_139 - GENERIC_ACTION_14 - GENERIC_ACTION_140 - GENERIC_ACTION_141 - GENERIC_ACTION_142 - GENERIC_ACTION_143 - GENERIC_ACTION_144 - GENERIC_ACTION_145 - GENERIC_ACTION_146 - GENERIC_ACTION_147 - GENERIC_ACTION_148 - GENERIC_ACTION_149 - GENERIC_ACTION_15 - GENERIC_ACTION_150 - GENERIC_ACTION_151 - GENERIC_ACTION_152 - GENERIC_ACTION_153 - GENERIC_ACTION_154 - GENERIC_ACTION_155 - GENERIC_ACTION_156 - GENERIC_ACTION_157 - GENERIC_ACTION_158 - GENERIC_ACTION_159 - GENERIC_ACTION_16 - GENERIC_ACTION_160 - GENERIC_ACTION_161 - GENERIC_ACTION_162 - GENERIC_ACTION_163 - GENERIC_ACTION_164 - GENERIC_ACTION_165 - GENERIC_ACTION_166 - GENERIC_ACTION_167 - GENERIC_ACTION_168 - GENERIC_ACTION_169 - GENERIC_ACTION_17 - GENERIC_ACTION_170 - GENERIC_ACTION_171 - GENERIC_ACTION_172 - GENERIC_ACTION_173 - GENERIC_ACTION_174 - GENERIC_ACTION_175 - GENERIC_ACTION_176 - GENERIC_ACTION_177 - GENERIC_ACTION_178 - GENERIC_ACTION_179 - GENERIC_ACTION_18 - GENERIC_ACTION_180 - GENERIC_ACTION_181 - GENERIC_ACTION_182 - GENERIC_ACTION_183 - GENERIC_ACTION_184 - GENERIC_ACTION_185 - GENERIC_ACTION_186 - GENERIC_ACTION_187 - GENERIC_ACTION_188 - GENERIC_ACTION_189 - GENERIC_ACTION_19 - GENERIC_ACTION_190 - GENERIC_ACTION_191 - GENERIC_ACTION_192 - GENERIC_ACTION_193 - GENERIC_ACTION_194 - GENERIC_ACTION_195 - GENERIC_ACTION_196 - GENERIC_ACTION_197 - GENERIC_ACTION_198 - GENERIC_ACTION_199 - GENERIC_ACTION_2 - GENERIC_ACTION_20 - GENERIC_ACTION_200 - GENERIC_ACTION_21 - GENERIC_ACTION_22 - GENERIC_ACTION_23 - GENERIC_ACTION_24 - GENERIC_ACTION_25 - GENERIC_ACTION_26 - GENERIC_ACTION_27 - GENERIC_ACTION_28 - GENERIC_ACTION_29 - GENERIC_ACTION_3 - GENERIC_ACTION_30 - GENERIC_ACTION_31 - GENERIC_ACTION_32 - GENERIC_ACTION_33 - GENERIC_ACTION_34 - GENERIC_ACTION_35 - GENERIC_ACTION_36 - GENERIC_ACTION_37 - GENERIC_ACTION_38 - GENERIC_ACTION_39 - GENERIC_ACTION_4 - GENERIC_ACTION_40 - GENERIC_ACTION_41 - GENERIC_ACTION_42 - GENERIC_ACTION_43 - GENERIC_ACTION_44 - GENERIC_ACTION_45 - GENERIC_ACTION_46 - GENERIC_ACTION_47 - GENERIC_ACTION_48 - GENERIC_ACTION_49 - GENERIC_ACTION_5 - GENERIC_ACTION_50 - GENERIC_ACTION_51 - GENERIC_ACTION_52 - GENERIC_ACTION_53 - GENERIC_ACTION_54 - GENERIC_ACTION_55 - GENERIC_ACTION_56 - GENERIC_ACTION_57 - GENERIC_ACTION_58 - GENERIC_ACTION_59 - GENERIC_ACTION_6 - GENERIC_ACTION_60 - GENERIC_ACTION_61 - GENERIC_ACTION_62 - GENERIC_ACTION_63 - GENERIC_ACTION_64 - GENERIC_ACTION_65 - GENERIC_ACTION_66 - GENERIC_ACTION_67 - GENERIC_ACTION_68 - GENERIC_ACTION_69 - GENERIC_ACTION_7 - GENERIC_ACTION_70 - GENERIC_ACTION_71 - GENERIC_ACTION_72 - GENERIC_ACTION_73 - GENERIC_ACTION_74 - GENERIC_ACTION_75 - GENERIC_ACTION_76 - GENERIC_ACTION_77 - GENERIC_ACTION_78 - GENERIC_ACTION_79 - GENERIC_ACTION_8 - GENERIC_ACTION_80 - GENERIC_ACTION_81 - GENERIC_ACTION_82 - GENERIC_ACTION_83 - GENERIC_ACTION_84 - GENERIC_ACTION_85 - GENERIC_ACTION_86 - GENERIC_ACTION_87 - GENERIC_ACTION_88 - GENERIC_ACTION_89 - GENERIC_ACTION_9 - GENERIC_ACTION_90 - GENERIC_ACTION_91 - GENERIC_ACTION_92 - GENERIC_ACTION_93 - GENERIC_ACTION_94 - GENERIC_ACTION_95 - GENERIC_ACTION_96 - GENERIC_ACTION_97 - GENERIC_ACTION_98 - GENERIC_ACTION_99 - THEME_GENERIC_ACTION_1 - THEME_GENERIC_ACTION_10 - THEME_GENERIC_ACTION_11 - THEME_GENERIC_ACTION_12 - THEME_GENERIC_ACTION_13 - THEME_GENERIC_ACTION_14 - THEME_GENERIC_ACTION_15 - THEME_GENERIC_ACTION_16 - THEME_GENERIC_ACTION_17 - THEME_GENERIC_ACTION_18 - THEME_GENERIC_ACTION_19 - THEME_GENERIC_ACTION_2 - THEME_GENERIC_ACTION_20 - THEME_GENERIC_ACTION_21 - THEME_GENERIC_ACTION_22 - THEME_GENERIC_ACTION_23 - THEME_GENERIC_ACTION_24 - THEME_GENERIC_ACTION_25 - THEME_GENERIC_ACTION_26 - THEME_GENERIC_ACTION_27 - THEME_GENERIC_ACTION_28 - THEME_GENERIC_ACTION_29 - THEME_GENERIC_ACTION_3 - THEME_GENERIC_ACTION_30 - THEME_GENERIC_ACTION_4 - THEME_GENERIC_ACTION_5 - THEME_GENERIC_ACTION_6 - THEME_GENERIC_ACTION_7 - THEME_GENERIC_ACTION_8 - THEME_GENERIC_ACTION_9 type: string required: - count_rewards_based_on_partner_user_id - data_attribute_matcher_type - data_attribute_name - data_attribute_value - expression - id - is_email_required - is_referral_loop_allowed - is_unique_friend_required - min_cart_value - referrals_per_reward - reward_count_limit - reward_count_since_days - reward_count_since_month - reward_every_x_friend_actions - reward_slots - reward_supplier_id - reward_value_limit - reward_value_since_days - reward_value_since_month - rewardee - trigger_action_type type: object TransitionRuleResponse: properties: action_type: enum: - ANY_CLICK - ANY_PROMOTION - ANY_PURCHASE - ANY_REGISTER - ANY_SHARE - ANY_SHARE_REWARD - GENERIC_ACTION_1 - GENERIC_ACTION_10 - GENERIC_ACTION_100 - GENERIC_ACTION_101 - GENERIC_ACTION_102 - GENERIC_ACTION_103 - GENERIC_ACTION_104 - GENERIC_ACTION_105 - GENERIC_ACTION_106 - GENERIC_ACTION_107 - GENERIC_ACTION_108 - GENERIC_ACTION_109 - GENERIC_ACTION_11 - GENERIC_ACTION_110 - GENERIC_ACTION_111 - GENERIC_ACTION_112 - GENERIC_ACTION_113 - GENERIC_ACTION_114 - GENERIC_ACTION_115 - GENERIC_ACTION_116 - GENERIC_ACTION_117 - GENERIC_ACTION_118 - GENERIC_ACTION_119 - GENERIC_ACTION_12 - GENERIC_ACTION_120 - GENERIC_ACTION_121 - GENERIC_ACTION_122 - GENERIC_ACTION_123 - GENERIC_ACTION_124 - GENERIC_ACTION_125 - GENERIC_ACTION_126 - GENERIC_ACTION_127 - GENERIC_ACTION_128 - GENERIC_ACTION_129 - GENERIC_ACTION_13 - GENERIC_ACTION_130 - GENERIC_ACTION_131 - GENERIC_ACTION_132 - GENERIC_ACTION_133 - GENERIC_ACTION_134 - GENERIC_ACTION_135 - GENERIC_ACTION_136 - GENERIC_ACTION_137 - GENERIC_ACTION_138 - GENERIC_ACTION_139 - GENERIC_ACTION_14 - GENERIC_ACTION_140 - GENERIC_ACTION_141 - GENERIC_ACTION_142 - GENERIC_ACTION_143 - GENERIC_ACTION_144 - GENERIC_ACTION_145 - GENERIC_ACTION_146 - GENERIC_ACTION_147 - GENERIC_ACTION_148 - GENERIC_ACTION_149 - GENERIC_ACTION_15 - GENERIC_ACTION_150 - GENERIC_ACTION_151 - GENERIC_ACTION_152 - GENERIC_ACTION_153 - GENERIC_ACTION_154 - GENERIC_ACTION_155 - GENERIC_ACTION_156 - GENERIC_ACTION_157 - GENERIC_ACTION_158 - GENERIC_ACTION_159 - GENERIC_ACTION_16 - GENERIC_ACTION_160 - GENERIC_ACTION_161 - GENERIC_ACTION_162 - GENERIC_ACTION_163 - GENERIC_ACTION_164 - GENERIC_ACTION_165 - GENERIC_ACTION_166 - GENERIC_ACTION_167 - GENERIC_ACTION_168 - GENERIC_ACTION_169 - GENERIC_ACTION_17 - GENERIC_ACTION_170 - GENERIC_ACTION_171 - GENERIC_ACTION_172 - GENERIC_ACTION_173 - GENERIC_ACTION_174 - GENERIC_ACTION_175 - GENERIC_ACTION_176 - GENERIC_ACTION_177 - GENERIC_ACTION_178 - GENERIC_ACTION_179 - GENERIC_ACTION_18 - GENERIC_ACTION_180 - GENERIC_ACTION_181 - GENERIC_ACTION_182 - GENERIC_ACTION_183 - GENERIC_ACTION_184 - GENERIC_ACTION_185 - GENERIC_ACTION_186 - GENERIC_ACTION_187 - GENERIC_ACTION_188 - GENERIC_ACTION_189 - GENERIC_ACTION_19 - GENERIC_ACTION_190 - GENERIC_ACTION_191 - GENERIC_ACTION_192 - GENERIC_ACTION_193 - GENERIC_ACTION_194 - GENERIC_ACTION_195 - GENERIC_ACTION_196 - GENERIC_ACTION_197 - GENERIC_ACTION_198 - GENERIC_ACTION_199 - GENERIC_ACTION_2 - GENERIC_ACTION_20 - GENERIC_ACTION_200 - GENERIC_ACTION_21 - GENERIC_ACTION_22 - GENERIC_ACTION_23 - GENERIC_ACTION_24 - GENERIC_ACTION_25 - GENERIC_ACTION_26 - GENERIC_ACTION_27 - GENERIC_ACTION_28 - GENERIC_ACTION_29 - GENERIC_ACTION_3 - GENERIC_ACTION_30 - GENERIC_ACTION_31 - GENERIC_ACTION_32 - GENERIC_ACTION_33 - GENERIC_ACTION_34 - GENERIC_ACTION_35 - GENERIC_ACTION_36 - GENERIC_ACTION_37 - GENERIC_ACTION_38 - GENERIC_ACTION_39 - GENERIC_ACTION_4 - GENERIC_ACTION_40 - GENERIC_ACTION_41 - GENERIC_ACTION_42 - GENERIC_ACTION_43 - GENERIC_ACTION_44 - GENERIC_ACTION_45 - GENERIC_ACTION_46 - GENERIC_ACTION_47 - GENERIC_ACTION_48 - GENERIC_ACTION_49 - GENERIC_ACTION_5 - GENERIC_ACTION_50 - GENERIC_ACTION_51 - GENERIC_ACTION_52 - GENERIC_ACTION_53 - GENERIC_ACTION_54 - GENERIC_ACTION_55 - GENERIC_ACTION_56 - GENERIC_ACTION_57 - GENERIC_ACTION_58 - GENERIC_ACTION_59 - GENERIC_ACTION_6 - GENERIC_ACTION_60 - GENERIC_ACTION_61 - GENERIC_ACTION_62 - GENERIC_ACTION_63 - GENERIC_ACTION_64 - GENERIC_ACTION_65 - GENERIC_ACTION_66 - GENERIC_ACTION_67 - GENERIC_ACTION_68 - GENERIC_ACTION_69 - GENERIC_ACTION_7 - GENERIC_ACTION_70 - GENERIC_ACTION_71 - GENERIC_ACTION_72 - GENERIC_ACTION_73 - GENERIC_ACTION_74 - GENERIC_ACTION_75 - GENERIC_ACTION_76 - GENERIC_ACTION_77 - GENERIC_ACTION_78 - GENERIC_ACTION_79 - GENERIC_ACTION_8 - GENERIC_ACTION_80 - GENERIC_ACTION_81 - GENERIC_ACTION_82 - GENERIC_ACTION_83 - GENERIC_ACTION_84 - GENERIC_ACTION_85 - GENERIC_ACTION_86 - GENERIC_ACTION_87 - GENERIC_ACTION_88 - GENERIC_ACTION_89 - GENERIC_ACTION_9 - GENERIC_ACTION_90 - GENERIC_ACTION_91 - GENERIC_ACTION_92 - GENERIC_ACTION_93 - GENERIC_ACTION_94 - GENERIC_ACTION_95 - GENERIC_ACTION_96 - GENERIC_ACTION_97 - GENERIC_ACTION_98 - GENERIC_ACTION_99 - THEME_GENERIC_ACTION_1 - THEME_GENERIC_ACTION_10 - THEME_GENERIC_ACTION_11 - THEME_GENERIC_ACTION_12 - THEME_GENERIC_ACTION_13 - THEME_GENERIC_ACTION_14 - THEME_GENERIC_ACTION_15 - THEME_GENERIC_ACTION_16 - THEME_GENERIC_ACTION_17 - THEME_GENERIC_ACTION_18 - THEME_GENERIC_ACTION_19 - THEME_GENERIC_ACTION_2 - THEME_GENERIC_ACTION_20 - THEME_GENERIC_ACTION_21 - THEME_GENERIC_ACTION_22 - THEME_GENERIC_ACTION_23 - THEME_GENERIC_ACTION_24 - THEME_GENERIC_ACTION_25 - THEME_GENERIC_ACTION_26 - THEME_GENERIC_ACTION_27 - THEME_GENERIC_ACTION_28 - THEME_GENERIC_ACTION_29 - THEME_GENERIC_ACTION_3 - THEME_GENERIC_ACTION_30 - THEME_GENERIC_ACTION_4 - THEME_GENERIC_ACTION_5 - THEME_GENERIC_ACTION_6 - THEME_GENERIC_ACTION_7 - THEME_GENERIC_ACTION_8 - THEME_GENERIC_ACTION_9 type: string approve_high_quality: type: boolean approve_low_quality: type: boolean transition_period_milliseconds: format: int64 type: integer transition_rule_id: type: string required: - action_type - approve_high_quality - approve_low_quality - transition_period_milliseconds - transition_rule_id type: object BuiltCampaignControllerResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignStepResponseBase' - properties: actions: items: $ref: '#/components/schemas/BuiltCampaignControllerActionResponse' type: array aliases: items: type: string type: array controller_id: type: string enabled_on_states: items: enum: - ARCHIVED - ENDED - LIVE - NOT_LAUNCHED - PAUSED - STOPPED type: string type: array uniqueItems: true id: readOnly: true type: string journey_names: items: type: string type: array uniqueItems: true name: type: string scope: enum: - CLIENT - PRIVATE - PUBLIC type: string selectors: items: enum: - BEST_REFERRAL - BEST_REFERRAL_SAME_PROGRAM - MATCHING_CAMPAIGN - TARGET type: string type: array send_policy: enum: - ALL - FIRST_ONLY type: string type: enum: - CONTROLLER type: string type: object required: - actions - aliases - component_ids - component_references - controller_id - created_date - data - enabled - enabled_on_states - id - journey_names - name - scope - selectors - send_policy - step_builder - triggers - type - updated_date type: object title: CONTROLLER BuiltCampaignFrontendControllerResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignStepResponseBase' - properties: actions: items: $ref: '#/components/schemas/BuiltCampaignControllerActionResponse' type: array aliases: items: type: string type: array category: type: string enabled_on_states: items: enum: - ARCHIVED - ENDED - LIVE - NOT_LAUNCHED - PAUSED - STOPPED type: string type: array uniqueItems: true id: readOnly: true type: string journey_names: items: type: string type: array uniqueItems: true name: type: string scope: enum: - CLIENT - PRIVATE - PUBLIC type: string send_policy: enum: - ALL - FIRST_ONLY type: string type: enum: - FRONTEND_CONTROLLER type: string type: object required: - actions - aliases - category - component_ids - component_references - created_date - data - enabled - enabled_on_states - id - journey_names - name - scope - send_policy - step_builder - triggers - type - updated_date type: object title: FRONTEND_CONTROLLER BuiltCampaignJourneyEntryResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignStepResponseBase' - properties: id: readOnly: true type: string journey_name: type: string key: $ref: '#/components/schemas/BuiltJourneyKeyResponse' priority: $ref: '#/components/schemas/DeweyDecimal' type: enum: - JOURNEY_ENTRY type: string type: object required: - component_ids - component_references - created_date - data - enabled - id - journey_name - key - priority - step_builder - triggers - type - updated_date type: object title: JOURNEY_ENTRY BuiltCampaignComponentVariableResponseAsAdminIcon: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - ADMIN_ICON type: string type: object type: object title: ADMIN_ICON BuiltCampaignComponentVariableResponseAsAudienceId: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - AUDIENCE_ID type: string type: object type: object title: AUDIENCE_ID BuiltCampaignComponentVariableResponseAsAudienceIdList: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - AUDIENCE_ID_LIST type: string type: object type: object title: AUDIENCE_ID_LIST BuiltCampaignComponentVariableResponseAsBoolean: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - BOOLEAN type: string type: object type: object title: BOOLEAN BuiltCampaignComponentVariableResponseAsBrowserSideJavascript: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - BROWSER_SIDE_JAVASCRIPT type: string type: object type: object title: BROWSER_SIDE_JAVASCRIPT BuiltCampaignComponentVariableResponseAsClientDomainIdList: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - CLIENT_DOMAIN_ID_LIST type: string type: object type: object title: CLIENT_DOMAIN_ID_LIST BuiltCampaignComponentVariableResponseAsClientKey: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - CLIENT_KEY type: string type: object type: object title: CLIENT_KEY BuiltComponentClientKeyFlowVariableResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: authorization_url: type: string client_secret_key_id: type: string description: type: string redirect_url: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - CLIENT_KEY_FLOW type: string type: object required: - authorization_url - client_secret_key_id - description - display_name - name - priority - redirect_url - source - source_component_id - source_version - tags - type - values type: object title: CLIENT_KEY_FLOW BuiltCampaignComponentVariableResponseAsColor: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - COLOR type: string type: object type: object title: COLOR BuiltComponentComponentIdVariableResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string filter: $ref: '#/components/schemas/ComponentIdFilterResponse' source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - COMPONENT_ID type: string type: object required: - description - display_name - filter - name - priority - source - source_component_id - source_version - tags - type - values type: object title: COMPONENT_ID BuiltComponentComponentSettingLookupVariableResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: capture_settings: items: type: string type: array captured_setting_values_description: type: string description: type: string filters: items: $ref: '#/components/schemas/SettingFilterResponse' type: array matching_filters: items: $ref: '#/components/schemas/SettingFilterResponse' type: array source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - COMPONENT_SETTING_LOOKUP type: string type: object required: - capture_settings - captured_setting_values_description - description - display_name - filters - matching_filters - name - priority - source - source_component_id - source_version - tags - type - values type: object title: COMPONENT_SETTING_LOOKUP BuiltCampaignComponentVariableResponseAsCss: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - CSS type: string type: object type: object title: CSS BuiltCampaignComponentVariableResponseAsDelay: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - DELAY type: string type: object type: object title: DELAY BuiltCampaignComponentVariableResponseAsDelayList: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - DELAY_LIST type: string type: object type: object title: DELAY_LIST BuiltComponentEnumVariableResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: allowed_values: items: type: string type: array description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - ENUM type: string type: object required: - allowed_values - description - display_name - name - priority - source - source_component_id - source_version - tags - type - values type: object title: ENUM BuiltComponentEnumListVariableResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: allowed_values: items: type: string type: array description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - ENUM_LIST type: string type: object required: - allowed_values - description - display_name - name - priority - source - source_component_id - source_version - tags - type - values type: object title: ENUM_LIST BuiltCampaignComponentVariableResponseAsExtoleClientKey: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - EXTOLE_CLIENT_KEY type: string type: object type: object title: EXTOLE_CLIENT_KEY BuiltCampaignComponentVariableResponseAsFont: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - FONT type: string type: object type: object title: FONT BuiltCampaignComponentVariableResponseAsGlobComponentPath: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - GLOB_COMPONENT_PATH type: string type: object type: object title: GLOB_COMPONENT_PATH BuiltCampaignComponentVariableResponseAsHtml: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - HTML type: string type: object type: object title: HTML BuiltCampaignComponentVariableResponseAsImage: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - IMAGE type: string type: object type: object title: IMAGE BuiltCampaignComponentVariableResponseAsInteger: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - INTEGER type: string type: object type: object title: INTEGER BuiltCampaignComponentVariableResponseAsIntegerList: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - INTEGER_LIST type: string type: object type: object title: INTEGER_LIST BuiltCampaignComponentVariableResponseAsJson: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - JSON type: string type: object type: object title: JSON BuiltComponentSocketResponseAsMultiSocket: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string filters: items: $ref: '#/components/schemas/SettingFilterResponse' type: array parameters: items: $ref: '#/components/schemas/BuiltCampaignComponentVariableResponse' type: array type: enum: - MULTI_SOCKET type: string type: object required: - description - display_name - filters - name - parameters - priority - tags - type - values type: object title: MULTI_SOCKET BuiltComponentPartnerEnumVariableResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - PARTNER_ENUM type: string webhook_id: type: string options: items: $ref: '#/components/schemas/PartnerEnumListVariableOptionResponse' type: array type: object required: - description - display_name - name - options - priority - source - source_component_id - source_version - tags - type - values - webhook_id type: object title: PARTNER_ENUM BuiltComponentPartnerEnumListVariableResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - PARTNER_ENUM_LIST type: string webhook_id: type: string options: items: $ref: '#/components/schemas/PartnerEnumListVariableOptionResponse' type: array type: object required: - description - display_name - name - options - priority - source - source_component_id - source_version - tags - type - values - webhook_id type: object title: PARTNER_ENUM_LIST BuiltCampaignComponentVariableResponseAsPersonKeyName: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - PERSON_KEY_NAME type: string type: object type: object title: PERSON_KEY_NAME BuiltCampaignComponentVariableResponseAsRewardSupplierId: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - REWARD_SUPPLIER_ID type: string type: object type: object title: REWARD_SUPPLIER_ID BuiltComponentRewardSupplierIdListVariableResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: allowed_reward_supplier_ids: items: type: string type: array description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - REWARD_SUPPLIER_ID_LIST type: string type: object required: - allowed_reward_supplier_ids - description - display_name - name - priority - source - source_component_id - source_version - tags - type - values type: object title: REWARD_SUPPLIER_ID_LIST BuiltComponentSocketResponseAsSocket: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string filters: items: $ref: '#/components/schemas/SettingFilterResponse' type: array parameters: items: $ref: '#/components/schemas/BuiltCampaignComponentVariableResponse' type: array type: enum: - SOCKET type: string type: object required: - description - display_name - filters - name - parameters - priority - tags - type - values type: object title: SOCKET BuiltCampaignComponentVariableResponseAsString: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - STRING type: string type: object type: object title: STRING BuiltCampaignComponentVariableResponseAsStringList: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - STRING_LIST type: string type: object type: object title: STRING_LIST BuiltComponentStringMapVariableResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: allowed_keys: items: type: string type: array description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - STRING_MAP type: string type: object required: - allowed_keys - description - display_name - name - priority - source - source_component_id - source_version - tags - type - values type: object title: STRING_MAP BuiltCampaignComponentVariableResponseAsUrl: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - URL type: string type: object type: object title: URL BuiltCampaignComponentVariableResponseAsWebhookId: allOf: - $ref: '#/components/schemas/BuiltCampaignComponentSettingResponseBase' - properties: description: type: string source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer type: enum: - WEBHOOK_ID type: string type: object type: object title: WEBHOOK_ID BuiltCampaignFlowStepAppTypeResponse: properties: name: type: string type: object RewardRuleExpression: properties: type: enum: - JS - SPEL type: string value: type: string type: object BuiltCampaignStepResponseBase: properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceResponse' type: array created_date: $ref: '#/components/schemas/ZonedDateTime' data: items: $ref: '#/components/schemas/BuiltStepDataResponse' type: array enabled: type: boolean id: readOnly: true type: string step_builder: $ref: '#/components/schemas/StepBuilderInBuiltCampaignStepResponseBase' triggers: items: $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponse' type: array type: enum: - CONTROLLER - FRONTEND_CONTROLLER - JOURNEY_ENTRY type: string updated_date: $ref: '#/components/schemas/ZonedDateTime' type: object BuiltCampaignControllerActionResponse: discriminator: mapping: APPROVE: $ref: '#/components/schemas/BuiltCampaignControllerActionApproveResponse' CANCEL_REWARD: $ref: >- #/components/schemas/BuiltCampaignControllerActionCancelRewardResponse CREATE_MEMBERSHIP: $ref: >- #/components/schemas/BuiltCampaignControllerActionCreateMembershipResponse CREATIVE: $ref: '#/components/schemas/BuiltCampaignControllerActionCreativeResponse' DATA_INTELLIGENCE: $ref: >- #/components/schemas/BuiltCampaignControllerActionDataIntelligenceResponse DECLINE: $ref: '#/components/schemas/BuiltCampaignControllerActionDeclineResponse' DISPLAY: $ref: '#/components/schemas/BuiltCampaignControllerActionDisplayResponse' EARN_REWARD: $ref: >- #/components/schemas/BuiltCampaignControllerActionEarnRewardResponse EMAIL: $ref: '#/components/schemas/BuiltCampaignControllerActionEmailResponse' EXPRESSION: $ref: >- #/components/schemas/BuiltCampaignControllerActionExpressionResponse FIRE_AS_PERSON: $ref: >- #/components/schemas/BuiltCampaignControllerActionFireAsPersonResponse FULFILL_REWARD: $ref: >- #/components/schemas/BuiltCampaignControllerActionFulfillRewardResponse INCENTIVIZE: $ref: >- #/components/schemas/BuiltCampaignControllerActionIncentivizeResponse INCENTIVIZE_STATUS_UPDATE: $ref: >- #/components/schemas/BuiltCampaignControllerActionIncentivizeStatusUpdateResponse REDEEM_REWARD: $ref: >- #/components/schemas/BuiltCampaignControllerActionRedeemRewardResponse REMOVE_MEMBERSHIP: $ref: >- #/components/schemas/BuiltCampaignControllerActionRemoveMembershipResponse REVOKE_REWARD: $ref: >- #/components/schemas/BuiltCampaignControllerActionRevokeRewardResponse SCHEDULE: $ref: '#/components/schemas/BuiltCampaignControllerActionScheduleResponse' SHARE_EVENT: $ref: >- #/components/schemas/BuiltCampaignControllerActionShareEventResponse SIGNAL: $ref: '#/components/schemas/BuiltCampaignControllerActionSignalResponse' SIGNAL_V1: $ref: '#/components/schemas/BuiltCampaignControllerActionSignalV1Response' STEP_SIGNAL: $ref: >- #/components/schemas/BuiltCampaignControllerActionStepSignalResponse WEBHOOK: $ref: '#/components/schemas/BuiltCampaignControllerActionWebhookResponse' propertyName: action_type oneOf: - title: APPROVE allOf: - $ref: >- #/components/schemas/BuiltCampaignControllerActionApproveResponse - title: CANCEL_REWARD allOf: - $ref: >- #/components/schemas/BuiltCampaignControllerActionCancelRewardResponse - title: CREATE_MEMBERSHIP allOf: - $ref: >- #/components/schemas/BuiltCampaignControllerActionCreateMembershipResponse - title: CREATIVE allOf: - $ref: >- #/components/schemas/BuiltCampaignControllerActionCreativeResponse - title: DATA_INTELLIGENCE allOf: - $ref: >- #/components/schemas/BuiltCampaignControllerActionDataIntelligenceResponse - title: DECLINE allOf: - $ref: >- #/components/schemas/BuiltCampaignControllerActionDeclineResponse - title: DISPLAY allOf: - $ref: >- #/components/schemas/BuiltCampaignControllerActionDisplayResponse - title: EARN_REWARD allOf: - $ref: >- #/components/schemas/BuiltCampaignControllerActionEarnRewardResponse - title: EMAIL allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionEmailResponse' - title: EXPRESSION allOf: - $ref: >- #/components/schemas/BuiltCampaignControllerActionExpressionResponse - title: FIRE_AS_PERSON allOf: - $ref: >- #/components/schemas/BuiltCampaignControllerActionFireAsPersonResponse - title: FULFILL_REWARD allOf: - $ref: >- #/components/schemas/BuiltCampaignControllerActionFulfillRewardResponse - title: INCENTIVIZE allOf: - $ref: >- #/components/schemas/BuiltCampaignControllerActionIncentivizeResponse - title: INCENTIVIZE_STATUS_UPDATE allOf: - $ref: >- #/components/schemas/BuiltCampaignControllerActionIncentivizeStatusUpdateResponse - title: REDEEM_REWARD allOf: - $ref: >- #/components/schemas/BuiltCampaignControllerActionRedeemRewardResponse - title: REMOVE_MEMBERSHIP allOf: - $ref: >- #/components/schemas/BuiltCampaignControllerActionRemoveMembershipResponse - title: REVOKE_REWARD allOf: - $ref: >- #/components/schemas/BuiltCampaignControllerActionRevokeRewardResponse - title: SCHEDULE allOf: - $ref: >- #/components/schemas/BuiltCampaignControllerActionScheduleResponse - title: SHARE_EVENT allOf: - $ref: >- #/components/schemas/BuiltCampaignControllerActionShareEventResponse - title: SIGNAL allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionSignalResponse' - title: SIGNAL_V1 allOf: - $ref: >- #/components/schemas/BuiltCampaignControllerActionSignalV1Response - title: STEP_SIGNAL allOf: - $ref: >- #/components/schemas/BuiltCampaignControllerActionStepSignalResponse - title: WEBHOOK allOf: - $ref: >- #/components/schemas/BuiltCampaignControllerActionWebhookResponse BuiltJourneyKeyResponse: properties: name: type: string value: $ref: '#/components/schemas/ValueInBuiltJourneyKeyResponse' type: object DeweyDecimal: example: '10' type: string BuiltCampaignComponentSettingResponseBase: properties: display_name: type: string name: type: string priority: $ref: '#/components/schemas/DeweyDecimal' tags: items: type: string type: array uniqueItems: true type: enum: - ADMIN_ICON - AUDIENCE_ID - AUDIENCE_ID_LIST - BOOLEAN - BROWSER_SIDE_JAVASCRIPT - CLIENT_DOMAIN_ID_LIST - CLIENT_KEY - CLIENT_KEY_FLOW - COLOR - COMPONENT_ID - COMPONENT_SETTING_LOOKUP - CSS - DELAY - DELAY_LIST - ENUM - ENUM_LIST - EXTOLE_CLIENT_KEY - FONT - GLOB_COMPONENT_PATH - HTML - IMAGE - INTEGER - INTEGER_LIST - JSON - MULTI_SOCKET - PARTNER_ENUM - PARTNER_ENUM_LIST - PERSON_KEY_NAME - REWARD_SUPPLIER_ID - REWARD_SUPPLIER_ID_LIST - SOCKET - STRING - STRING_LIST - STRING_MAP - URL - WEBHOOK_ID type: string values: $ref: '#/components/schemas/BuiltComponentSettingValues' type: object ComponentIdFilterResponse: properties: component_types: items: type: string type: array uniqueItems: true type: object SettingFilterResponse: discriminator: mapping: COMPONENT_TYPE: $ref: '#/components/schemas/ComponentTypeSettingFilterResponse' EXPRESSION: $ref: '#/components/schemas/ExpressionSettingFilterResponse' FACET: $ref: '#/components/schemas/ComponentFacetSettingFilterResponse' propertyName: type oneOf: - title: COMPONENT_TYPE allOf: - $ref: '#/components/schemas/ComponentTypeSettingFilterResponse' - title: EXPRESSION allOf: - $ref: '#/components/schemas/ExpressionSettingFilterResponse' - title: FACET allOf: - $ref: '#/components/schemas/ComponentFacetSettingFilterResponse' BuiltCampaignComponentVariableResponse: properties: description: type: string display_name: type: string name: type: string priority: $ref: '#/components/schemas/DeweyDecimal' source: enum: - INHERITED - LOCAL - PARAMETER type: string source_component_id: type: string source_version: format: int32 type: integer tags: items: type: string type: array uniqueItems: true type: enum: - ADMIN_ICON - AUDIENCE_ID - AUDIENCE_ID_LIST - BOOLEAN - BROWSER_SIDE_JAVASCRIPT - CLIENT_DOMAIN_ID_LIST - CLIENT_KEY - CLIENT_KEY_FLOW - COLOR - COMPONENT_ID - COMPONENT_SETTING_LOOKUP - CSS - DELAY - DELAY_LIST - ENUM - ENUM_LIST - EXTOLE_CLIENT_KEY - FONT - GLOB_COMPONENT_PATH - HTML - IMAGE - INTEGER - INTEGER_LIST - JSON - MULTI_SOCKET - PARTNER_ENUM - PARTNER_ENUM_LIST - PERSON_KEY_NAME - REWARD_SUPPLIER_ID - REWARD_SUPPLIER_ID_LIST - SOCKET - STRING - STRING_LIST - STRING_MAP - URL - WEBHOOK_ID type: string values: $ref: '#/components/schemas/BuiltComponentSettingValues' type: object PartnerEnumListVariableOptionResponse: properties: id: type: string name: type: string type: object BuiltStepDataResponse: properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceResponse' type: array default_value: $ref: '#/components/schemas/DefaultValueInBuiltStepDataResponse' dimension: type: boolean enabled: type: boolean id: readOnly: true type: string key_type: enum: - NONE - PARTNER_EVENT_KEY - PARTNER_PROFILE_KEY - UNIQUE_PARTNER_EVENT_KEY - VALUE type: string name: type: string persist_types: items: enum: - JOURNEY - PROFILE - STEP type: string type: array scope: enum: - CLIENT - PRIVATE - PUBLIC type: string value: $ref: '#/components/schemas/ValueInBuiltStepDataResponse' required: - component_ids - component_references - default_value - dimension - enabled - id - key_type - name - persist_types - scope - value type: object StepBuilderInBuiltCampaignStepResponseBase: description: >- The step builder as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal step builder title: Static Value type: object - description: >- Handlebars expression with [StepBuilderContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/builder/StepBuilderContext.d.ts). example: handlebars@runtime:{{stepBuilder}} externalDocs: description: StepBuilderContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/builder/StepBuilderContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [StepBuilderContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/builder/StepBuilderContext.d.ts). example: javascript@runtime:function() { return context.get('stepBuilder');} externalDocs: description: StepBuilderContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/builder/StepBuilderContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string BuiltCampaignControllerTriggerResponse: discriminator: mapping: ACCESS: $ref: '#/components/schemas/BuiltCampaignControllerTriggerAccessResponse' AUDIENCE_MEMBERSHIP: $ref: >- #/components/schemas/BuiltCampaignControllerTriggerAudienceMembershipResponse AUDIENCE_MEMBERSHIP_EVENT: $ref: >- #/components/schemas/BuiltCampaignControllerTriggerAudienceMembershipEventResponse CLIENT_DOMAIN: $ref: >- #/components/schemas/BuiltCampaignControllerTriggerClientDomainResponse DATA_INTELLIGENCE_EVENT: $ref: >- #/components/schemas/BuiltCampaignControllerTriggerDataIntelligenceEventResponse EVENT: $ref: '#/components/schemas/BuiltCampaignControllerTriggerEventResponse' EVENT_TARGETING: $ref: >- #/components/schemas/BuiltCampaignControllerTriggerEventTargetingResponse EXPRESSION: $ref: >- #/components/schemas/BuiltCampaignControllerTriggerExpressionResponse GROUP: $ref: '#/components/schemas/BuiltCampaignControllerTriggerGroupResponse' HAS_IDENTITY: $ref: >- #/components/schemas/BuiltCampaignControllerTriggerHasIdentityResponse HAS_PRIOR_REWARD: $ref: >- #/components/schemas/BuiltCampaignControllerTriggerHasPriorRewardResponse HAS_PRIOR_STEP: $ref: >- #/components/schemas/BuiltCampaignControllerTriggerHasPriorStepResponse JOURNEY_CHECK: $ref: >- #/components/schemas/BuiltCampaignControllerTriggerJourneyCheckResponse LEGACY_LABEL_TARGETING: $ref: >- #/components/schemas/BuiltCampaignControllerTriggerLegacyLabelTargetingResponse LEGACY_QUALITY: $ref: >- #/components/schemas/BuiltCampaignControllerTriggerLegacyQualityResponse MAXMIND: $ref: '#/components/schemas/BuiltCampaignControllerTriggerMaxMindResponse' REFERRED_BY_EVENT: $ref: >- #/components/schemas/BuiltCampaignControllerTriggerReferredByEventResponse REWARD_EVENT: $ref: >- #/components/schemas/BuiltCampaignControllerTriggerRewardEventResponse SCORE: $ref: '#/components/schemas/BuiltCampaignControllerTriggerScoreResponse' SEND_REWARD_EVENT: $ref: >- #/components/schemas/BuiltCampaignControllerTriggerSendRewardEventResponse SHARE: $ref: '#/components/schemas/BuiltCampaignControllerTriggerShareResponse' STEP_EVENT: $ref: >- #/components/schemas/BuiltCampaignControllerTriggerStepEventResponse STICKY_JOURNEY: $ref: >- #/components/schemas/BuiltCampaignControllerTriggerStickyJourneyResponse TARGETING: $ref: >- #/components/schemas/BuiltCampaignControllerTriggerTargetingResponse ZONE_STATE: $ref: >- #/components/schemas/BuiltCampaignControllerTriggerZoneStateResponse propertyName: trigger_type oneOf: - title: ACCESS allOf: - $ref: >- #/components/schemas/BuiltCampaignControllerTriggerAccessResponse - title: AUDIENCE_MEMBERSHIP allOf: - $ref: >- #/components/schemas/BuiltCampaignControllerTriggerAudienceMembershipResponse - title: AUDIENCE_MEMBERSHIP_EVENT allOf: - $ref: >- #/components/schemas/BuiltCampaignControllerTriggerAudienceMembershipEventResponse - title: CLIENT_DOMAIN allOf: - $ref: >- #/components/schemas/BuiltCampaignControllerTriggerClientDomainResponse - title: DATA_INTELLIGENCE_EVENT allOf: - $ref: >- #/components/schemas/BuiltCampaignControllerTriggerDataIntelligenceEventResponse - title: EVENT allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerEventResponse' - title: EVENT_TARGETING allOf: - $ref: >- #/components/schemas/BuiltCampaignControllerTriggerEventTargetingResponse - title: EXPRESSION allOf: - $ref: >- #/components/schemas/BuiltCampaignControllerTriggerExpressionResponse - title: GROUP allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerGroupResponse' - title: HAS_IDENTITY allOf: - $ref: >- #/components/schemas/BuiltCampaignControllerTriggerHasIdentityResponse - title: HAS_PRIOR_REWARD allOf: - $ref: >- #/components/schemas/BuiltCampaignControllerTriggerHasPriorRewardResponse - title: HAS_PRIOR_STEP allOf: - $ref: >- #/components/schemas/BuiltCampaignControllerTriggerHasPriorStepResponse - title: JOURNEY_CHECK allOf: - $ref: >- #/components/schemas/BuiltCampaignControllerTriggerJourneyCheckResponse - title: LEGACY_LABEL_TARGETING allOf: - $ref: >- #/components/schemas/BuiltCampaignControllerTriggerLegacyLabelTargetingResponse - title: LEGACY_QUALITY allOf: - $ref: >- #/components/schemas/BuiltCampaignControllerTriggerLegacyQualityResponse - title: MAXMIND allOf: - $ref: >- #/components/schemas/BuiltCampaignControllerTriggerMaxMindResponse - title: REFERRED_BY_EVENT allOf: - $ref: >- #/components/schemas/BuiltCampaignControllerTriggerReferredByEventResponse - title: REWARD_EVENT allOf: - $ref: >- #/components/schemas/BuiltCampaignControllerTriggerRewardEventResponse - title: SCORE allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerScoreResponse' - title: SEND_REWARD_EVENT allOf: - $ref: >- #/components/schemas/BuiltCampaignControllerTriggerSendRewardEventResponse - title: SHARE allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerShareResponse' - title: STEP_EVENT allOf: - $ref: >- #/components/schemas/BuiltCampaignControllerTriggerStepEventResponse - title: STICKY_JOURNEY allOf: - $ref: >- #/components/schemas/BuiltCampaignControllerTriggerStickyJourneyResponse - title: TARGETING allOf: - $ref: >- #/components/schemas/BuiltCampaignControllerTriggerTargetingResponse - title: ZONE_STATE allOf: - $ref: >- #/components/schemas/BuiltCampaignControllerTriggerZoneStateResponse required: - component_ids - component_references - enabled - negated - parent_trigger_group_name - trigger_description - trigger_id - trigger_name - trigger_phase - trigger_type BuiltCampaignControllerActionApproveResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - APPROVE type: string cause_type: type: string event_type: type: string force: type: string legacy_action_id: type: string note: type: string partner_event_id: type: string polling_id: type: string polling_name: type: string reward_tags: $ref: >- #/components/schemas/RewardTagsInBuiltCampaignControllerActionApproveResponse type: object required: - action_id - action_type - cause_type - component_ids - component_references - enabled - event_type - force - legacy_action_id - note - partner_event_id - polling_id - polling_name - quality - reward_tags type: object title: APPROVE BuiltCampaignControllerActionCancelRewardResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - CANCEL_REWARD type: string message: type: string reward_id: type: string type: object required: - action_id - action_type - component_ids - component_references - enabled - message - quality - reward_id type: object title: CANCEL_REWARD BuiltCampaignControllerActionCreateMembershipResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - CREATE_MEMBERSHIP type: string audience_id: type: string type: object required: - action_id - action_type - audience_id - component_ids - component_references - enabled - quality type: object title: CREATE_MEMBERSHIP BuiltCampaignControllerActionCreativeResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - CREATIVE type: string api_version: format: int32 type: integer build_version: format: int32 type: integer classification: enum: - EMAIL - JAVASCRIPT - PAGE type: string has_creative: type: boolean latest_version: format: int32 type: integer theme_version: type: string type: object required: - action_id - action_type - api_version - build_version - classification - component_ids - component_references - enabled - has_creative - latest_version - quality - theme_version type: object title: CREATIVE BuiltCampaignControllerActionDataIntelligenceResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - DATA_INTELLIGENCE type: string event_name: type: string intelligence_provider: enum: - EMAIL_AGE - MAXMIND - NOOP type: string profile_risk_update_interval: $ref: '#/components/schemas/Duration' type: object required: - action_id - action_type - component_ids - component_references - enabled - event_name - intelligence_provider - profile_risk_update_interval - quality type: object title: DATA_INTELLIGENCE BuiltCampaignControllerActionDeclineResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - DECLINE type: string cause_type: type: string event_type: type: string legacy_action_id: type: string note: type: string partner_event_id: type: string polling_id: type: string polling_name: type: string type: object required: - action_id - action_type - cause_type - component_ids - component_references - enabled - event_type - legacy_action_id - note - partner_event_id - polling_id - polling_name - quality type: object title: DECLINE BuiltCampaignControllerActionDisplayResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - DISPLAY type: string body: $ref: >- #/components/schemas/BodyInBuiltCampaignControllerActionDisplayResponse headers: $ref: >- #/components/schemas/HeadersInBuiltCampaignControllerActionDisplayResponse response: $ref: >- #/components/schemas/ResponseInBuiltCampaignControllerActionDisplayResponse type: object type: object title: DISPLAY BuiltCampaignControllerActionEarnRewardResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - EARN_REWARD type: string data: $ref: >- #/components/schemas/DataMapInBuiltCampaignControllerActionEarnRewardResponse extra_data: $ref: >- #/components/schemas/ExtraDataInBuiltCampaignControllerActionEarnRewardResponse reward_action_id: $ref: >- #/components/schemas/RewardActionIdInBuiltCampaignControllerActionEarnRewardResponse reward_name: type: string reward_supplier_id: type: string slots: $ref: >- #/components/schemas/SlotsInBuiltCampaignControllerActionEarnRewardResponse tags: $ref: >- #/components/schemas/TagsInBuiltCampaignControllerActionEarnRewardResponse value_of_event_being_rewarded: $ref: >- #/components/schemas/ValueOfEventBeingRewardedInBuiltCampaignControllerActionEarnRewardResponse type: object required: - action_id - action_type - component_ids - component_references - data - enabled - extra_data - quality - reward_action_id - reward_name - reward_supplier_id - slots - tags - value_of_event_being_rewarded type: object title: EARN_REWARD BuiltCampaignControllerActionEmailResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - EMAIL type: string data: $ref: >- #/components/schemas/DataMapInBuiltCampaignControllerActionEmailResponse zone_name: type: string type: object type: object title: EMAIL BuiltCampaignControllerActionExpressionResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - EXPRESSION type: string data: $ref: >- #/components/schemas/DataMapInBuiltCampaignControllerActionExpressionResponse expression: $ref: >- #/components/schemas/ExpressionInBuiltCampaignControllerActionExpressionResponse type: object required: - action_id - action_type - component_ids - component_references - data - enabled - expression - quality type: object title: EXPRESSION BuiltCampaignControllerActionFireAsPersonResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - FIRE_AS_PERSON type: string as_person_identification: $ref: '#/components/schemas/FireAsPersonIdentification' as_person_journey: $ref: '#/components/schemas/FireAsPersonJourney' data: $ref: >- #/components/schemas/DataMapInBuiltCampaignControllerActionFireAsPersonResponse event_name: type: string event_time: $ref: >- #/components/schemas/EventTimeInBuiltCampaignControllerActionFireAsPersonResponse extra_data: $ref: >- #/components/schemas/ExtraDataInBuiltCampaignControllerActionFireAsPersonResponse labels: items: type: string type: array uniqueItems: true person_id: $ref: >- #/components/schemas/PersonIdInBuiltCampaignControllerActionFireAsPersonResponse type: object type: object title: FIRE_AS_PERSON BuiltCampaignControllerActionFulfillRewardResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - FULFILL_REWARD type: string message: type: string partner_reward_id: $ref: >- #/components/schemas/PartnerRewardIdInBuiltCampaignControllerActionFulfillRewardResponse reward_id: type: string success: type: string type: object required: - action_id - action_type - component_ids - component_references - enabled - message - partner_reward_id - quality - reward_id - success type: object title: FULFILL_REWARD BuiltCampaignControllerActionIncentivizeResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_name: type: string action_type: enum: - INCENTIVIZE type: string data: $ref: >- #/components/schemas/DataMapInBuiltCampaignControllerActionIncentivizeResponse incentivize_action_type: enum: - CLICK - GENERIC_ACTION_1 - GENERIC_ACTION_10 - GENERIC_ACTION_100 - GENERIC_ACTION_101 - GENERIC_ACTION_102 - GENERIC_ACTION_103 - GENERIC_ACTION_104 - GENERIC_ACTION_105 - GENERIC_ACTION_106 - GENERIC_ACTION_107 - GENERIC_ACTION_108 - GENERIC_ACTION_109 - GENERIC_ACTION_11 - GENERIC_ACTION_110 - GENERIC_ACTION_111 - GENERIC_ACTION_112 - GENERIC_ACTION_113 - GENERIC_ACTION_114 - GENERIC_ACTION_115 - GENERIC_ACTION_116 - GENERIC_ACTION_117 - GENERIC_ACTION_118 - GENERIC_ACTION_119 - GENERIC_ACTION_12 - GENERIC_ACTION_120 - GENERIC_ACTION_121 - GENERIC_ACTION_122 - GENERIC_ACTION_123 - GENERIC_ACTION_124 - GENERIC_ACTION_125 - GENERIC_ACTION_126 - GENERIC_ACTION_127 - GENERIC_ACTION_128 - GENERIC_ACTION_129 - GENERIC_ACTION_13 - GENERIC_ACTION_130 - GENERIC_ACTION_131 - GENERIC_ACTION_132 - GENERIC_ACTION_133 - GENERIC_ACTION_134 - GENERIC_ACTION_135 - GENERIC_ACTION_136 - GENERIC_ACTION_137 - GENERIC_ACTION_138 - GENERIC_ACTION_139 - GENERIC_ACTION_14 - GENERIC_ACTION_140 - GENERIC_ACTION_141 - GENERIC_ACTION_142 - GENERIC_ACTION_143 - GENERIC_ACTION_144 - GENERIC_ACTION_145 - GENERIC_ACTION_146 - GENERIC_ACTION_147 - GENERIC_ACTION_148 - GENERIC_ACTION_149 - GENERIC_ACTION_15 - GENERIC_ACTION_150 - GENERIC_ACTION_151 - GENERIC_ACTION_152 - GENERIC_ACTION_153 - GENERIC_ACTION_154 - GENERIC_ACTION_155 - GENERIC_ACTION_156 - GENERIC_ACTION_157 - GENERIC_ACTION_158 - GENERIC_ACTION_159 - GENERIC_ACTION_16 - GENERIC_ACTION_160 - GENERIC_ACTION_161 - GENERIC_ACTION_162 - GENERIC_ACTION_163 - GENERIC_ACTION_164 - GENERIC_ACTION_165 - GENERIC_ACTION_166 - GENERIC_ACTION_167 - GENERIC_ACTION_168 - GENERIC_ACTION_169 - GENERIC_ACTION_17 - GENERIC_ACTION_170 - GENERIC_ACTION_171 - GENERIC_ACTION_172 - GENERIC_ACTION_173 - GENERIC_ACTION_174 - GENERIC_ACTION_175 - GENERIC_ACTION_176 - GENERIC_ACTION_177 - GENERIC_ACTION_178 - GENERIC_ACTION_179 - GENERIC_ACTION_18 - GENERIC_ACTION_180 - GENERIC_ACTION_181 - GENERIC_ACTION_182 - GENERIC_ACTION_183 - GENERIC_ACTION_184 - GENERIC_ACTION_185 - GENERIC_ACTION_186 - GENERIC_ACTION_187 - GENERIC_ACTION_188 - GENERIC_ACTION_189 - GENERIC_ACTION_19 - GENERIC_ACTION_190 - GENERIC_ACTION_191 - GENERIC_ACTION_192 - GENERIC_ACTION_193 - GENERIC_ACTION_194 - GENERIC_ACTION_195 - GENERIC_ACTION_196 - GENERIC_ACTION_197 - GENERIC_ACTION_198 - GENERIC_ACTION_199 - GENERIC_ACTION_2 - GENERIC_ACTION_20 - GENERIC_ACTION_200 - GENERIC_ACTION_21 - GENERIC_ACTION_22 - GENERIC_ACTION_23 - GENERIC_ACTION_24 - GENERIC_ACTION_25 - GENERIC_ACTION_26 - GENERIC_ACTION_27 - GENERIC_ACTION_28 - GENERIC_ACTION_29 - GENERIC_ACTION_3 - GENERIC_ACTION_30 - GENERIC_ACTION_31 - GENERIC_ACTION_32 - GENERIC_ACTION_33 - GENERIC_ACTION_34 - GENERIC_ACTION_35 - GENERIC_ACTION_36 - GENERIC_ACTION_37 - GENERIC_ACTION_38 - GENERIC_ACTION_39 - GENERIC_ACTION_4 - GENERIC_ACTION_40 - GENERIC_ACTION_41 - GENERIC_ACTION_42 - GENERIC_ACTION_43 - GENERIC_ACTION_44 - GENERIC_ACTION_45 - GENERIC_ACTION_46 - GENERIC_ACTION_47 - GENERIC_ACTION_48 - GENERIC_ACTION_49 - GENERIC_ACTION_5 - GENERIC_ACTION_50 - GENERIC_ACTION_51 - GENERIC_ACTION_52 - GENERIC_ACTION_53 - GENERIC_ACTION_54 - GENERIC_ACTION_55 - GENERIC_ACTION_56 - GENERIC_ACTION_57 - GENERIC_ACTION_58 - GENERIC_ACTION_59 - GENERIC_ACTION_6 - GENERIC_ACTION_60 - GENERIC_ACTION_61 - GENERIC_ACTION_62 - GENERIC_ACTION_63 - GENERIC_ACTION_64 - GENERIC_ACTION_65 - GENERIC_ACTION_66 - GENERIC_ACTION_67 - GENERIC_ACTION_68 - GENERIC_ACTION_69 - GENERIC_ACTION_7 - GENERIC_ACTION_70 - GENERIC_ACTION_71 - GENERIC_ACTION_72 - GENERIC_ACTION_73 - GENERIC_ACTION_74 - GENERIC_ACTION_75 - GENERIC_ACTION_76 - GENERIC_ACTION_77 - GENERIC_ACTION_78 - GENERIC_ACTION_79 - GENERIC_ACTION_8 - GENERIC_ACTION_80 - GENERIC_ACTION_81 - GENERIC_ACTION_82 - GENERIC_ACTION_83 - GENERIC_ACTION_84 - GENERIC_ACTION_85 - GENERIC_ACTION_86 - GENERIC_ACTION_87 - GENERIC_ACTION_88 - GENERIC_ACTION_89 - GENERIC_ACTION_9 - GENERIC_ACTION_90 - GENERIC_ACTION_91 - GENERIC_ACTION_92 - GENERIC_ACTION_93 - GENERIC_ACTION_94 - GENERIC_ACTION_95 - GENERIC_ACTION_96 - GENERIC_ACTION_97 - GENERIC_ACTION_98 - GENERIC_ACTION_99 - IMPRESSION - PROMOTION - PURCHASE - REGISTER - SHARE - SHARE_REWARD - THEME_GENERIC_ACTION_1 - THEME_GENERIC_ACTION_10 - THEME_GENERIC_ACTION_11 - THEME_GENERIC_ACTION_12 - THEME_GENERIC_ACTION_13 - THEME_GENERIC_ACTION_14 - THEME_GENERIC_ACTION_15 - THEME_GENERIC_ACTION_16 - THEME_GENERIC_ACTION_17 - THEME_GENERIC_ACTION_18 - THEME_GENERIC_ACTION_19 - THEME_GENERIC_ACTION_2 - THEME_GENERIC_ACTION_20 - THEME_GENERIC_ACTION_21 - THEME_GENERIC_ACTION_22 - THEME_GENERIC_ACTION_23 - THEME_GENERIC_ACTION_24 - THEME_GENERIC_ACTION_25 - THEME_GENERIC_ACTION_26 - THEME_GENERIC_ACTION_27 - THEME_GENERIC_ACTION_28 - THEME_GENERIC_ACTION_29 - THEME_GENERIC_ACTION_3 - THEME_GENERIC_ACTION_30 - THEME_GENERIC_ACTION_4 - THEME_GENERIC_ACTION_5 - THEME_GENERIC_ACTION_6 - THEME_GENERIC_ACTION_7 - THEME_GENERIC_ACTION_8 - THEME_GENERIC_ACTION_9 type: string overrides: additionalProperties: type: string type: object review_status: enum: - EVALUATING - PENDING type: string type: object type: object title: INCENTIVIZE BuiltCampaignControllerActionIncentivizeStatusUpdateResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - INCENTIVIZE_STATUS_UPDATE type: string data: $ref: >- #/components/schemas/DataMapInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse event_type: $ref: >- #/components/schemas/EventTypeInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse legacy_action_id: $ref: >- #/components/schemas/LegacyActionIdInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse message: $ref: >- #/components/schemas/MessageInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse move_to_pending: type: boolean partner_event_id: $ref: >- #/components/schemas/PartnerEventIdInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse review_status: $ref: >- #/components/schemas/ReviewStatusInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse type: object type: object title: INCENTIVIZE_STATUS_UPDATE BuiltCampaignControllerActionRedeemRewardResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - REDEEM_REWARD type: string data: additionalProperties: type: string type: object partner_event_id: type: string reward_id: type: string type: object required: - action_id - action_type - component_ids - component_references - data - enabled - partner_event_id - quality - reward_id type: object title: REDEEM_REWARD BuiltCampaignControllerActionRemoveMembershipResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - REMOVE_MEMBERSHIP type: string audience_id: type: string type: object required: - action_id - action_type - audience_id - component_ids - component_references - enabled - quality type: object title: REMOVE_MEMBERSHIP BuiltCampaignControllerActionRevokeRewardResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - REVOKE_REWARD type: string message: type: string reward_id: type: string type: object required: - action_id - action_type - component_ids - component_references - enabled - message - quality - reward_id type: object title: REVOKE_REWARD BuiltCampaignControllerActionScheduleResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - SCHEDULE type: string data: $ref: >- #/components/schemas/DataMapInBuiltCampaignControllerActionScheduleResponse dates: $ref: >- #/components/schemas/DatesInBuiltCampaignControllerActionScheduleResponse delays: $ref: >- #/components/schemas/DelaysInBuiltCampaignControllerActionScheduleResponse extra_data: $ref: >- #/components/schemas/ExtraDataInBuiltCampaignControllerActionScheduleResponse force: type: boolean schedule_name: $ref: >- #/components/schemas/ScheduleNameInBuiltCampaignControllerActionScheduleResponse type: object required: - action_id - action_type - component_ids - component_references - data - dates - delays - enabled - extra_data - force - quality - schedule_name type: object title: SCHEDULE BuiltCampaignControllerActionShareEventResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - SHARE_EVENT type: string required: - action_id - action_type - component_ids - component_references - enabled - quality type: object title: SHARE_EVENT BuiltCampaignControllerActionSignalResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - SIGNAL type: string data: $ref: >- #/components/schemas/DataMapInBuiltCampaignControllerActionSignalResponse name: $ref: >- #/components/schemas/NameInBuiltCampaignControllerActionSignalResponse signal_polling_id: $ref: >- #/components/schemas/SignalPollingIdInBuiltCampaignControllerActionSignalResponse type: object required: - action_id - action_type - component_ids - component_references - data - enabled - name - quality - signal_polling_id type: object title: SIGNAL BuiltCampaignControllerActionSignalV1Response: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - SIGNAL_V1 type: string data: additionalProperties: type: string type: object signal_polling_id: type: string type: object required: - action_id - action_type - component_ids - component_references - data - enabled - quality - signal_polling_id type: object title: SIGNAL_V1 BuiltCampaignControllerActionStepSignalResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - STEP_SIGNAL type: string name: type: string polling_id: type: string type: object required: - action_id - action_type - component_ids - component_references - enabled - name - polling_id - quality type: object title: STEP_SIGNAL BuiltCampaignControllerActionWebhookResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerActionResponseBase' - properties: action_type: enum: - WEBHOOK type: string data: $ref: >- #/components/schemas/DataMapInBuiltCampaignControllerActionWebhookResponse webhook_id: type: string type: object required: - action_id - action_type - component_ids - component_references - data - enabled - quality - webhook_id type: object title: WEBHOOK ValueInBuiltJourneyKeyResponse: description: >- The value as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal value title: Static Value type: object - description: >- Handlebars expression with [JourneyKeyContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/journey/JourneyKeyContext.d.ts). example: handlebars@runtime:{{value}} externalDocs: description: JourneyKeyContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/journey/JourneyKeyContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [JourneyKeyContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/journey/JourneyKeyContext.d.ts). example: javascript@runtime:function() { return context.get('value');} externalDocs: description: JourneyKeyContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/journey/JourneyKeyContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string BuiltComponentSettingValues: additionalProperties: true description: >- Open map of evaluated setting values keyed by value key. There is no fixed or maximum number of keys. Any string key may be present; each value uses the same shape for this setting's `type`. The properties listed here are common examples only and are not required. properties: default: $ref: '#/components/schemas/DefaultInBuiltComponentSettingValues' en: $ref: '#/components/schemas/EnInBuiltComponentSettingValues' type: object ComponentTypeSettingFilterResponse: allOf: - $ref: '#/components/schemas/SettingFilterResponseBase' - properties: component_type: type: string type: enum: - COMPONENT_TYPE type: string type: object required: - component_type - type type: object title: COMPONENT_TYPE ExpressionSettingFilterResponse: allOf: - $ref: '#/components/schemas/SettingFilterResponseBase' - properties: expression: $ref: '#/components/schemas/ExpressionInExpressionSettingFilterResponse' type: enum: - EXPRESSION type: string type: object description: >- Stored expression setting filter definition. Field `expression` is unevaluated and appears in buildtime-evaluatable form. required: - expression - type type: object title: EXPRESSION ComponentFacetSettingFilterResponse: allOf: - $ref: '#/components/schemas/SettingFilterResponseBase' - properties: name: type: string type: enum: - FACET type: string value: type: string type: object required: - name - type - value type: object title: FACET DefaultValueInBuiltStepDataResponse: description: >- The default value as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal default value title: Static Value type: object - description: >- Handlebars expression with [StepDataContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/data/StepDataContext.d.ts). example: handlebars@runtime:{{defaultValue}} externalDocs: description: StepDataContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/data/StepDataContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [StepDataContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/data/StepDataContext.d.ts). example: javascript@runtime:function() { return context.get('defaultValue');} externalDocs: description: StepDataContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/data/StepDataContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string ValueInBuiltStepDataResponse: description: >- The value as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal value title: Static Value type: object - description: >- Handlebars expression with [StepDataContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/data/StepDataContext.d.ts). example: handlebars@runtime:{{value}} externalDocs: description: StepDataContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/data/StepDataContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [StepDataContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/data/StepDataContext.d.ts). example: javascript@runtime:function() { return context.get('value');} externalDocs: description: StepDataContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/data/StepDataContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string BuiltCampaignControllerTriggerAccessResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: trigger_type: enum: - ACCESS type: string trusted_scopes: items: enum: - BACKEND - CLIENT_ADMIN - CLIENT_REPORT_DOWNLOAD - CLIENT_SUPERUSER - ONE_TIME - PASSWORD_RESET - UPDATE_PROFILE - USER_SUPPORT - VERIFIED_CONSUMER type: string type: array uniqueItems: true type: object required: - component_ids - component_references - enabled - negated - parent_trigger_group_name - trigger_description - trigger_id - trigger_name - trigger_phase - trigger_type - trusted_scopes type: object title: ACCESS BuiltCampaignControllerTriggerAudienceMembershipResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: having_any_audience_id: items: type: string type: array uniqueItems: true person_id: $ref: >- #/components/schemas/PersonIdInBuiltCampaignControllerTriggerAudienceMembershipResponse trigger_type: enum: - AUDIENCE_MEMBERSHIP type: string type: object required: - component_ids - component_references - enabled - having_any_audience_id - negated - parent_trigger_group_name - person_id - trigger_description - trigger_id - trigger_name - trigger_phase - trigger_type type: object title: AUDIENCE_MEMBERSHIP BuiltCampaignControllerTriggerAudienceMembershipEventResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: audience_ids: items: type: string type: array uniqueItems: true event_types: items: enum: - CREATED - REMOVED - UPDATED type: string type: array uniqueItems: true trigger_type: enum: - AUDIENCE_MEMBERSHIP_EVENT type: string type: object required: - audience_ids - component_ids - component_references - enabled - event_types - negated - parent_trigger_group_name - trigger_description - trigger_id - trigger_name - trigger_phase - trigger_type type: object title: AUDIENCE_MEMBERSHIP_EVENT BuiltCampaignControllerTriggerClientDomainResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: client_domain_ids: items: type: string type: array uniqueItems: true trigger_type: enum: - CLIENT_DOMAIN type: string type: object required: - client_domain_ids - component_ids - component_references - enabled - negated - parent_trigger_group_name - trigger_description - trigger_id - trigger_name - trigger_phase - trigger_type type: object title: CLIENT_DOMAIN BuiltCampaignControllerTriggerDataIntelligenceEventResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: event_name: type: string trigger_type: enum: - DATA_INTELLIGENCE_EVENT type: string type: object required: - component_ids - component_references - enabled - event_name - negated - parent_trigger_group_name - trigger_description - trigger_id - trigger_name - trigger_phase - trigger_type type: object title: DATA_INTELLIGENCE_EVENT BuiltCampaignControllerTriggerEventResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: event_names: items: type: string type: array event_type: enum: - ASSET - DATA_INTELLIGENCE - DISPLACED - DISPLACED_BY - FORWARDED - IDENTIFIED - INPUT - INTERNAL - LEGACY_CONSUMER_EVENT - MESSAGE - MESSAGE_NOT_DELIVERED - REFERRED - REFERRED_BY - SCHEDULED - SHARE - SHAREABLE - STEP type: string trigger_type: enum: - EVENT type: string type: object type: object title: EVENT BuiltCampaignControllerTriggerEventTargetingResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: targeting_attributes: additionalProperties: type: string type: object trigger_type: enum: - EVENT_TARGETING type: string type: object type: object title: EVENT_TARGETING BuiltCampaignControllerTriggerExpressionResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: data: additionalProperties: type: string type: object expression: $ref: >- #/components/schemas/ExpressionInBuiltCampaignControllerTriggerExpressionResponse trigger_type: enum: - EXPRESSION type: string type: object type: object title: EXPRESSION BuiltCampaignControllerTriggerGroupResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: operator: enum: - AND - OR type: string trigger_type: enum: - GROUP type: string type: object type: object title: GROUP BuiltCampaignControllerTriggerHasIdentityResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: trigger_type: enum: - HAS_IDENTITY type: string required: - component_ids - component_references - enabled - negated - parent_trigger_group_name - trigger_description - trigger_id - trigger_name - trigger_phase - trigger_type type: object title: HAS_IDENTITY BuiltCampaignControllerTriggerHasPriorRewardResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: count_matches: items: format: int32 type: integer type: array uniqueItems: true count_max: format: int32 type: integer count_min: format: int32 type: integer filter_expressions: items: type: string type: array uniqueItems: true filter_face_value_types: items: enum: - AUD - BRL - CAD - CNY - EUR - GBP - HKD - INR - JPY - KRW - MONTH - MXN - NZD - PERCENT_OFF - POINTS - TRY - TWD - USD type: string type: array uniqueItems: true filter_max_age: $ref: '#/components/schemas/Duration' filter_max_date: $ref: '#/components/schemas/ZonedDateTime' filter_min_age: $ref: '#/components/schemas/Duration' filter_min_date: $ref: '#/components/schemas/ZonedDateTime' filter_names: items: type: string type: array uniqueItems: true filter_reward_supplier_ids: items: type: string type: array uniqueItems: true filter_scope: enum: - CAMPAIGN - CLIENT - JOURNEY - PROGRAM type: string filter_states: items: enum: - CANCELED - EARNED - FAILED - FULFILLED - REDEEMED - REVOKED - SENT type: string type: array uniqueItems: true filter_tags: items: type: string type: array uniqueItems: true sum_of_face_value_max: type: number sum_of_face_value_min: type: number tax_year_start: $ref: '#/components/schemas/MonthDay' trigger_type: enum: - HAS_PRIOR_REWARD type: string type: object required: - component_ids - component_references - count_matches - count_max - count_min - enabled - filter_expressions - filter_face_value_types - filter_max_age - filter_max_date - filter_min_age - filter_min_date - filter_names - filter_reward_supplier_ids - filter_scope - filter_states - filter_tags - negated - parent_trigger_group_name - sum_of_face_value_max - sum_of_face_value_min - tax_year_start - trigger_description - trigger_id - trigger_name - trigger_phase - trigger_type type: object title: HAS_PRIOR_REWARD BuiltCampaignControllerTriggerHasPriorStepResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: count_matches: items: format: int32 type: integer type: array uniqueItems: true count_max: format: int32 type: integer count_min: format: int32 type: integer filter_campaign_id: type: string filter_campaign_ids: $ref: >- #/components/schemas/FilterCampaignIdsInBuiltCampaignControllerTriggerHasPriorStepResponse filter_expression: $ref: >- #/components/schemas/FilterExpressionInBuiltCampaignControllerTriggerHasPriorStepResponse filter_expressions: items: type: string type: array uniqueItems: true filter_max_age: $ref: '#/components/schemas/Duration' filter_max_date: $ref: '#/components/schemas/ZonedDateTime' filter_max_value: type: number filter_min_age: $ref: '#/components/schemas/Duration' filter_min_date: $ref: '#/components/schemas/ZonedDateTime' filter_min_value: type: number filter_names: items: type: string type: array uniqueItems: true filter_partner_event_id: $ref: '#/components/schemas/PartnerEventId' filter_partner_event_id_name: type: string filter_partner_event_id_value: type: string filter_program_label: type: string filter_program_labels: $ref: >- #/components/schemas/FilterProgramLabelsInBuiltCampaignControllerTriggerHasPriorStepResponse filter_quality: enum: - ANY - HIGH - LOW type: string filter_scope: enum: - ATTRIBUTED - CAMPAIGN - CLIENT - JOURNEY - PROGRAM type: string having_all_names: $ref: >- #/components/schemas/HavingAllNamesInBuiltCampaignControllerTriggerHasPriorStepResponse person_id: $ref: >- #/components/schemas/PersonIdInBuiltCampaignControllerTriggerHasPriorStepResponse sum_of_value_max: type: number sum_of_value_min: type: number trigger_type: enum: - HAS_PRIOR_STEP type: string type: object required: - component_ids - component_references - count_matches - count_max - count_min - enabled - filter_campaign_id - filter_campaign_ids - filter_expression - filter_expressions - filter_max_age - filter_max_date - filter_max_value - filter_min_age - filter_min_date - filter_min_value - filter_names - filter_partner_event_id - filter_partner_event_id_name - filter_partner_event_id_value - filter_program_label - filter_program_labels - filter_quality - filter_scope - having_all_names - negated - parent_trigger_group_name - person_id - sum_of_value_max - sum_of_value_min - trigger_description - trigger_id - trigger_name - trigger_phase - trigger_type type: object title: HAS_PRIOR_STEP BuiltCampaignControllerTriggerJourneyCheckResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: journey_name: type: string person_id: $ref: >- #/components/schemas/PersonIdInBuiltCampaignControllerTriggerJourneyCheckResponse trigger_type: enum: - JOURNEY_CHECK type: string type: object type: object title: JOURNEY_CHECK BuiltCampaignControllerTriggerLegacyLabelTargetingResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: trigger_type: enum: - LEGACY_LABEL_TARGETING type: string required: - component_ids - component_references - enabled - negated - parent_trigger_group_name - trigger_description - trigger_id - trigger_name - trigger_phase - trigger_type type: object title: LEGACY_LABEL_TARGETING BuiltCampaignControllerTriggerLegacyQualityResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: action_type: enum: - ANY_CLICK - ANY_PROMOTION - ANY_PURCHASE - ANY_REGISTER - ANY_SHARE - ANY_SHARE_REWARD - GENERIC_ACTION_1 - GENERIC_ACTION_10 - GENERIC_ACTION_100 - GENERIC_ACTION_101 - GENERIC_ACTION_102 - GENERIC_ACTION_103 - GENERIC_ACTION_104 - GENERIC_ACTION_105 - GENERIC_ACTION_106 - GENERIC_ACTION_107 - GENERIC_ACTION_108 - GENERIC_ACTION_109 - GENERIC_ACTION_11 - GENERIC_ACTION_110 - GENERIC_ACTION_111 - GENERIC_ACTION_112 - GENERIC_ACTION_113 - GENERIC_ACTION_114 - GENERIC_ACTION_115 - GENERIC_ACTION_116 - GENERIC_ACTION_117 - GENERIC_ACTION_118 - GENERIC_ACTION_119 - GENERIC_ACTION_12 - GENERIC_ACTION_120 - GENERIC_ACTION_121 - GENERIC_ACTION_122 - GENERIC_ACTION_123 - GENERIC_ACTION_124 - GENERIC_ACTION_125 - GENERIC_ACTION_126 - GENERIC_ACTION_127 - GENERIC_ACTION_128 - GENERIC_ACTION_129 - GENERIC_ACTION_13 - GENERIC_ACTION_130 - GENERIC_ACTION_131 - GENERIC_ACTION_132 - GENERIC_ACTION_133 - GENERIC_ACTION_134 - GENERIC_ACTION_135 - GENERIC_ACTION_136 - GENERIC_ACTION_137 - GENERIC_ACTION_138 - GENERIC_ACTION_139 - GENERIC_ACTION_14 - GENERIC_ACTION_140 - GENERIC_ACTION_141 - GENERIC_ACTION_142 - GENERIC_ACTION_143 - GENERIC_ACTION_144 - GENERIC_ACTION_145 - GENERIC_ACTION_146 - GENERIC_ACTION_147 - GENERIC_ACTION_148 - GENERIC_ACTION_149 - GENERIC_ACTION_15 - GENERIC_ACTION_150 - GENERIC_ACTION_151 - GENERIC_ACTION_152 - GENERIC_ACTION_153 - GENERIC_ACTION_154 - GENERIC_ACTION_155 - GENERIC_ACTION_156 - GENERIC_ACTION_157 - GENERIC_ACTION_158 - GENERIC_ACTION_159 - GENERIC_ACTION_16 - GENERIC_ACTION_160 - GENERIC_ACTION_161 - GENERIC_ACTION_162 - GENERIC_ACTION_163 - GENERIC_ACTION_164 - GENERIC_ACTION_165 - GENERIC_ACTION_166 - GENERIC_ACTION_167 - GENERIC_ACTION_168 - GENERIC_ACTION_169 - GENERIC_ACTION_17 - GENERIC_ACTION_170 - GENERIC_ACTION_171 - GENERIC_ACTION_172 - GENERIC_ACTION_173 - GENERIC_ACTION_174 - GENERIC_ACTION_175 - GENERIC_ACTION_176 - GENERIC_ACTION_177 - GENERIC_ACTION_178 - GENERIC_ACTION_179 - GENERIC_ACTION_18 - GENERIC_ACTION_180 - GENERIC_ACTION_181 - GENERIC_ACTION_182 - GENERIC_ACTION_183 - GENERIC_ACTION_184 - GENERIC_ACTION_185 - GENERIC_ACTION_186 - GENERIC_ACTION_187 - GENERIC_ACTION_188 - GENERIC_ACTION_189 - GENERIC_ACTION_19 - GENERIC_ACTION_190 - GENERIC_ACTION_191 - GENERIC_ACTION_192 - GENERIC_ACTION_193 - GENERIC_ACTION_194 - GENERIC_ACTION_195 - GENERIC_ACTION_196 - GENERIC_ACTION_197 - GENERIC_ACTION_198 - GENERIC_ACTION_199 - GENERIC_ACTION_2 - GENERIC_ACTION_20 - GENERIC_ACTION_200 - GENERIC_ACTION_21 - GENERIC_ACTION_22 - GENERIC_ACTION_23 - GENERIC_ACTION_24 - GENERIC_ACTION_25 - GENERIC_ACTION_26 - GENERIC_ACTION_27 - GENERIC_ACTION_28 - GENERIC_ACTION_29 - GENERIC_ACTION_3 - GENERIC_ACTION_30 - GENERIC_ACTION_31 - GENERIC_ACTION_32 - GENERIC_ACTION_33 - GENERIC_ACTION_34 - GENERIC_ACTION_35 - GENERIC_ACTION_36 - GENERIC_ACTION_37 - GENERIC_ACTION_38 - GENERIC_ACTION_39 - GENERIC_ACTION_4 - GENERIC_ACTION_40 - GENERIC_ACTION_41 - GENERIC_ACTION_42 - GENERIC_ACTION_43 - GENERIC_ACTION_44 - GENERIC_ACTION_45 - GENERIC_ACTION_46 - GENERIC_ACTION_47 - GENERIC_ACTION_48 - GENERIC_ACTION_49 - GENERIC_ACTION_5 - GENERIC_ACTION_50 - GENERIC_ACTION_51 - GENERIC_ACTION_52 - GENERIC_ACTION_53 - GENERIC_ACTION_54 - GENERIC_ACTION_55 - GENERIC_ACTION_56 - GENERIC_ACTION_57 - GENERIC_ACTION_58 - GENERIC_ACTION_59 - GENERIC_ACTION_6 - GENERIC_ACTION_60 - GENERIC_ACTION_61 - GENERIC_ACTION_62 - GENERIC_ACTION_63 - GENERIC_ACTION_64 - GENERIC_ACTION_65 - GENERIC_ACTION_66 - GENERIC_ACTION_67 - GENERIC_ACTION_68 - GENERIC_ACTION_69 - GENERIC_ACTION_7 - GENERIC_ACTION_70 - GENERIC_ACTION_71 - GENERIC_ACTION_72 - GENERIC_ACTION_73 - GENERIC_ACTION_74 - GENERIC_ACTION_75 - GENERIC_ACTION_76 - GENERIC_ACTION_77 - GENERIC_ACTION_78 - GENERIC_ACTION_79 - GENERIC_ACTION_8 - GENERIC_ACTION_80 - GENERIC_ACTION_81 - GENERIC_ACTION_82 - GENERIC_ACTION_83 - GENERIC_ACTION_84 - GENERIC_ACTION_85 - GENERIC_ACTION_86 - GENERIC_ACTION_87 - GENERIC_ACTION_88 - GENERIC_ACTION_89 - GENERIC_ACTION_9 - GENERIC_ACTION_90 - GENERIC_ACTION_91 - GENERIC_ACTION_92 - GENERIC_ACTION_93 - GENERIC_ACTION_94 - GENERIC_ACTION_95 - GENERIC_ACTION_96 - GENERIC_ACTION_97 - GENERIC_ACTION_98 - GENERIC_ACTION_99 - THEME_GENERIC_ACTION_1 - THEME_GENERIC_ACTION_10 - THEME_GENERIC_ACTION_11 - THEME_GENERIC_ACTION_12 - THEME_GENERIC_ACTION_13 - THEME_GENERIC_ACTION_14 - THEME_GENERIC_ACTION_15 - THEME_GENERIC_ACTION_16 - THEME_GENERIC_ACTION_17 - THEME_GENERIC_ACTION_18 - THEME_GENERIC_ACTION_19 - THEME_GENERIC_ACTION_2 - THEME_GENERIC_ACTION_20 - THEME_GENERIC_ACTION_21 - THEME_GENERIC_ACTION_22 - THEME_GENERIC_ACTION_23 - THEME_GENERIC_ACTION_24 - THEME_GENERIC_ACTION_25 - THEME_GENERIC_ACTION_26 - THEME_GENERIC_ACTION_27 - THEME_GENERIC_ACTION_28 - THEME_GENERIC_ACTION_29 - THEME_GENERIC_ACTION_3 - THEME_GENERIC_ACTION_30 - THEME_GENERIC_ACTION_4 - THEME_GENERIC_ACTION_5 - THEME_GENERIC_ACTION_6 - THEME_GENERIC_ACTION_7 - THEME_GENERIC_ACTION_8 - THEME_GENERIC_ACTION_9 type: string trigger_type: enum: - LEGACY_QUALITY type: string type: object type: object title: LEGACY_QUALITY BuiltCampaignControllerTriggerMaxMindResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: allow_high_risk_email: type: boolean default_quality_score: enum: - ERROR - HIGH - LOW type: string ip_threshold: format: int64 type: integer risk_threshold: format: int64 type: integer trigger_type: enum: - MAXMIND type: string type: object required: - allow_high_risk_email - component_ids - component_references - default_quality_score - enabled - ip_threshold - negated - parent_trigger_group_name - risk_threshold - trigger_description - trigger_id - trigger_name - trigger_phase - trigger_type type: object title: MAXMIND BuiltCampaignControllerTriggerReferredByEventResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: referral_originator: enum: - ADVOCATE - FRIEND nullable: true type: string trigger_type: enum: - REFERRED_BY_EVENT type: string type: object required: - component_ids - component_references - enabled - negated - parent_trigger_group_name - referral_originator - trigger_description - trigger_id - trigger_name - trigger_phase - trigger_type type: object title: REFERRED_BY_EVENT BuiltCampaignControllerTriggerRewardEventResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: event_names: items: type: string type: array uniqueItems: true reward_states: items: enum: - CANCELED - EARNED - FAILED - FULFILLED - REDEEMED - REVOKED type: string type: array uniqueItems: true slots: items: type: string type: array uniqueItems: true tags: items: type: string type: array uniqueItems: true trigger_type: enum: - REWARD_EVENT type: string type: object required: - component_ids - component_references - enabled - event_names - negated - parent_trigger_group_name - reward_states - slots - tags - trigger_description - trigger_id - trigger_name - trigger_phase - trigger_type type: object title: REWARD_EVENT BuiltCampaignControllerTriggerScoreResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: cause_event_name: type: string channel: type: string score_result: type: string trigger_type: enum: - SCORE type: string type: object required: - cause_event_name - channel - component_ids - component_references - enabled - negated - parent_trigger_group_name - score_result - trigger_description - trigger_id - trigger_name - trigger_phase - trigger_type type: object title: SCORE BuiltCampaignControllerTriggerSendRewardEventResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: reward_names: items: type: string type: array uniqueItems: true reward_states: items: enum: - FULFILLED - SENT type: string type: array uniqueItems: true tags: items: type: string type: array uniqueItems: true trigger_type: enum: - SEND_REWARD_EVENT type: string type: object required: - component_ids - component_references - enabled - negated - parent_trigger_group_name - reward_names - reward_states - tags - trigger_description - trigger_id - trigger_name - trigger_phase - trigger_type type: object title: SEND_REWARD_EVENT BuiltCampaignControllerTriggerShareResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: channels: items: enum: - ANY - EMAIL - EXTOLE_EMAIL - EXTOLE_TWITTER - FACEBOOK - TWITTER type: string type: array uniqueItems: true quality: enum: - ANY - HIGH - LOW type: string share_types: items: enum: - ANY - EMAIL - EXTOLE_EMAIL - EXTOLE_TWITTER - FACEBOOK - TWITTER type: string type: array uniqueItems: true writeOnly: true trigger_type: enum: - SHARE type: string type: object required: - channels - component_ids - component_references - enabled - negated - parent_trigger_group_name - quality - trigger_description - trigger_id - trigger_name - trigger_phase - trigger_type type: object title: SHARE BuiltCampaignControllerTriggerStepEventResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: event_names: items: type: string type: array uniqueItems: true having_any_data_name: items: type: string type: array uniqueItems: true trigger_type: enum: - STEP_EVENT type: string type: object type: object title: STEP_EVENT BuiltCampaignControllerTriggerStickyJourneyResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: label: type: string trigger_type: enum: - STICKY_JOURNEY type: string type: object type: object title: STICKY_JOURNEY BuiltCampaignControllerTriggerTargetingResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: scope: enum: - CAMPAIGN - JOURNEY - PROGRAM type: string trigger_type: enum: - TARGETING type: string type: object type: object title: TARGETING BuiltCampaignControllerTriggerZoneStateResponse: allOf: - $ref: '#/components/schemas/BuiltCampaignControllerTriggerResponseBase' - properties: invert_mapping_state: type: boolean step_name: nullable: true type: string trigger_type: enum: - ZONE_STATE type: string zone_name: nullable: true type: string type: object required: - component_ids - component_references - enabled - invert_mapping_state - negated - parent_trigger_group_name - step_name - trigger_description - trigger_id - trigger_name - trigger_phase - trigger_type - zone_name type: object title: ZONE_STATE BuiltCampaignControllerActionResponseBase: properties: action_id: type: string action_type: enum: - APPROVE - CANCEL_REWARD - CREATE_MEMBERSHIP - CREATIVE - DATA_INTELLIGENCE - DECLINE - DISPLAY - EARN_REWARD - EMAIL - EXPRESSION - FIRE_AS_PERSON - FULFILL_REWARD - INCENTIVIZE - INCENTIVIZE_STATUS_UPDATE - REDEEM_REWARD - REMOVE_MEMBERSHIP - REVOKE_REWARD - SCHEDULE - SHARE_EVENT - SIGNAL - SIGNAL_V1 - STEP_SIGNAL - WEBHOOK type: string component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceResponse' type: array enabled: type: boolean quality: enum: - ALWAYS - HIGH - LOW type: string type: object RewardTagsInBuiltCampaignControllerActionApproveResponse: description: >- The reward tags as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal reward tags items: type: string title: Static Value type: array uniqueItems: true - description: >- Handlebars expression with [ApproveActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/approve/ApproveActionContext.d.ts). example: handlebars@runtime:{{rewardTags}} externalDocs: description: ApproveActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/approve/ApproveActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [ApproveActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/approve/ApproveActionContext.d.ts). example: javascript@runtime:function() { return context.get('rewardTags');} externalDocs: description: ApproveActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/approve/ApproveActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string Duration: description: >- [RFC 5545](https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.6) duration string. example: PT42S pattern: >- ^[-+]?P(?:(?:[-+]?[0-9]+D)(?:T(?=(?:[-+]?[0-9]+H|[-+]?[0-9]+M|[-+]?[0-9]+(?:[.,][0-9]*)?S))(?:[-+]?[0-9]+H)?(?:[-+]?[0-9]+M)?(?:[-+]?[0-9]+(?:[.,][0-9]*)?S)?)?|T(?=(?:[-+]?[0-9]+H|[-+]?[0-9]+M|[-+]?[0-9]+(?:[.,][0-9]*)?S))(?:[-+]?[0-9]+H)?(?:[-+]?[0-9]+M)?(?:[-+]?[0-9]+(?:[.,][0-9]*)?S)?)$ type: string BodyInBuiltCampaignControllerActionDisplayResponse: description: >- The body as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@runtime:.* type: string - pattern: ^javascript@runtime:.* type: string type: string description: Literal body title: Static Value - description: >- Handlebars expression with [DisplayActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts). example: handlebars@runtime:{{body}} externalDocs: description: DisplayActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [DisplayActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts). example: javascript@runtime:function() { return context.get('body');} externalDocs: description: DisplayActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string HeadersInBuiltCampaignControllerActionDisplayResponse: description: >- The headers as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - additionalProperties: type: string description: Literal headers title: Static Value type: object - description: >- Handlebars expression with [DisplayActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts). example: handlebars@runtime:{{headers}} externalDocs: description: DisplayActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [DisplayActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts). example: javascript@runtime:function() { return context.get('headers');} externalDocs: description: DisplayActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string ResponseInBuiltCampaignControllerActionDisplayResponse: description: >- The response as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - allOf: - $ref: '#/components/schemas/ApiResponse' description: Literal response title: Static Value - description: >- Handlebars expression with [DisplayActionResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionResponseContext.d.ts). example: handlebars@runtime:{{response}} externalDocs: description: DisplayActionResponseContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionResponseContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [DisplayActionResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionResponseContext.d.ts). example: javascript@runtime:function() { return context.get('response');} externalDocs: description: DisplayActionResponseContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionResponseContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DataMapInBuiltCampaignControllerActionEarnRewardResponse: additionalProperties: $ref: >- #/components/schemas/DataInBuiltCampaignControllerActionEarnRewardResponse type: object ExtraDataInBuiltCampaignControllerActionEarnRewardResponse: description: >- The extra data as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - additionalProperties: type: object description: Literal extra data title: Static Value type: object - description: >- Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{extraData}} externalDocs: description: RewardActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('extraData');} externalDocs: description: RewardActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string RewardActionIdInBuiltCampaignControllerActionEarnRewardResponse: description: >- The reward action id as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal reward action id title: Static Value type: string - description: >- Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{rewardActionId}} externalDocs: description: RewardActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: >- javascript@runtime:function() { return context.get('rewardActionId');} externalDocs: description: RewardActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string SlotsInBuiltCampaignControllerActionEarnRewardResponse: description: >- The slots as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal slots items: type: string title: Static Value type: array uniqueItems: true - description: >- Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{slots}} externalDocs: description: RewardActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('slots');} externalDocs: description: RewardActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string TagsInBuiltCampaignControllerActionEarnRewardResponse: description: >- The tags as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal tags items: type: string title: Static Value type: array uniqueItems: true - description: >- Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{tags}} externalDocs: description: RewardActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('tags');} externalDocs: description: RewardActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string ValueOfEventBeingRewardedInBuiltCampaignControllerActionEarnRewardResponse: description: >- The value of event being rewarded as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal value of event being rewarded title: Static Value type: object - description: >- Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{valueOfEventBeingRewarded}} externalDocs: description: RewardActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: >- javascript@runtime:function() { return context.get('valueOfEventBeingRewarded');} externalDocs: description: RewardActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DataMapInBuiltCampaignControllerActionEmailResponse: additionalProperties: $ref: '#/components/schemas/DataInBuiltCampaignControllerActionEmailResponse' type: object DataMapInBuiltCampaignControllerActionExpressionResponse: additionalProperties: $ref: >- #/components/schemas/DataInBuiltCampaignControllerActionExpressionResponse type: object ExpressionInBuiltCampaignControllerActionExpressionResponse: description: >- The expression as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal expression title: Static Value type: object - description: >- Handlebars expression with [ExpressionActionCommandContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionCommandContext.d.ts). example: handlebars@runtime:{{expression}} externalDocs: description: ExpressionActionCommandContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionCommandContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [ExpressionActionCommandContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionCommandContext.d.ts). example: javascript@runtime:function() { return context.get('expression');} externalDocs: description: ExpressionActionCommandContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionCommandContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string FireAsPersonIdentification: discriminator: mapping: EMAIL: $ref: '#/components/schemas/EmailFireAsPersonIdentification' PARTNER_EVENT_ID: $ref: '#/components/schemas/PartnerEventIdFireAsPersonIdentification' PARTNER_USER_ID: $ref: '#/components/schemas/PartnerUserIdFireAsPersonIdentification' PERSON_ID: $ref: '#/components/schemas/PersonIdFireAsPersonIdentification' propertyName: person_identification_type oneOf: - title: EMAIL allOf: - $ref: '#/components/schemas/EmailFireAsPersonIdentification' - title: PARTNER_EVENT_ID allOf: - $ref: '#/components/schemas/PartnerEventIdFireAsPersonIdentification' - title: PARTNER_USER_ID allOf: - $ref: '#/components/schemas/PartnerUserIdFireAsPersonIdentification' - title: PERSON_ID allOf: - $ref: '#/components/schemas/PersonIdFireAsPersonIdentification' FireAsPersonJourney: properties: advocate_code: type: string advocate_partner_user_id: type: string campaign_id: type: string container: type: string coupon_code: type: string journey_type: type: string label: type: string promotable_code: type: string reason: type: string referral_reason: enum: - ADVOCATE - ADVOCATE_CODE - ADVOCATE_PARTNER_USER_ID - COUPON_CODE - DISPLACED_PARTNER_USER_ID - INCENTIVIZED_SHARE - PARTNER_EVENT_ID - PARTNER_SHARE_ID - SHAREABLE_ID - SHARE_ID - SHARE_RECIPIENT - UNKNOWN_REASON type: string share_id: type: string shareable_id: type: string zone: type: string type: object DataMapInBuiltCampaignControllerActionFireAsPersonResponse: additionalProperties: $ref: >- #/components/schemas/DataInBuiltCampaignControllerActionFireAsPersonResponse type: object EventTimeInBuiltCampaignControllerActionFireAsPersonResponse: description: >- The event time as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - allOf: - $ref: '#/components/schemas/ZonedDateTime' description: Literal event time title: Static Value - description: >- Handlebars expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: handlebars@runtime:{{eventTime}} externalDocs: description: FireAsPersonActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: javascript@runtime:function() { return context.get('eventTime');} externalDocs: description: FireAsPersonActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string ExtraDataInBuiltCampaignControllerActionFireAsPersonResponse: description: >- The extra data as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - additionalProperties: type: object description: Literal extra data title: Static Value type: object - description: >- Handlebars expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: handlebars@runtime:{{extraData}} externalDocs: description: FireAsPersonActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: javascript@runtime:function() { return context.get('extraData');} externalDocs: description: FireAsPersonActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string PersonIdInBuiltCampaignControllerActionFireAsPersonResponse: description: >- The person id as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal person id title: Static Value type: string - description: >- Handlebars expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: handlebars@runtime:{{personId}} externalDocs: description: FireAsPersonActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: javascript@runtime:function() { return context.get('personId');} externalDocs: description: FireAsPersonActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string PartnerRewardIdInBuiltCampaignControllerActionFulfillRewardResponse: description: >- The partner reward id as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal partner reward id title: Static Value type: string - description: >- Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{partnerRewardId}} externalDocs: description: RewardActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: >- javascript@runtime:function() { return context.get('partnerRewardId');} externalDocs: description: RewardActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DataMapInBuiltCampaignControllerActionIncentivizeResponse: additionalProperties: $ref: >- #/components/schemas/DataInBuiltCampaignControllerActionIncentivizeResponse type: object DataMapInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse: additionalProperties: $ref: >- #/components/schemas/DataInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse type: object EventTypeInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse: description: >- The event type as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal event type enum: - CLICK - GENERIC_ACTION_1 - GENERIC_ACTION_10 - GENERIC_ACTION_100 - GENERIC_ACTION_101 - GENERIC_ACTION_102 - GENERIC_ACTION_103 - GENERIC_ACTION_104 - GENERIC_ACTION_105 - GENERIC_ACTION_106 - GENERIC_ACTION_107 - GENERIC_ACTION_108 - GENERIC_ACTION_109 - GENERIC_ACTION_11 - GENERIC_ACTION_110 - GENERIC_ACTION_111 - GENERIC_ACTION_112 - GENERIC_ACTION_113 - GENERIC_ACTION_114 - GENERIC_ACTION_115 - GENERIC_ACTION_116 - GENERIC_ACTION_117 - GENERIC_ACTION_118 - GENERIC_ACTION_119 - GENERIC_ACTION_12 - GENERIC_ACTION_120 - GENERIC_ACTION_121 - GENERIC_ACTION_122 - GENERIC_ACTION_123 - GENERIC_ACTION_124 - GENERIC_ACTION_125 - GENERIC_ACTION_126 - GENERIC_ACTION_127 - GENERIC_ACTION_128 - GENERIC_ACTION_129 - GENERIC_ACTION_13 - GENERIC_ACTION_130 - GENERIC_ACTION_131 - GENERIC_ACTION_132 - GENERIC_ACTION_133 - GENERIC_ACTION_134 - GENERIC_ACTION_135 - GENERIC_ACTION_136 - GENERIC_ACTION_137 - GENERIC_ACTION_138 - GENERIC_ACTION_139 - GENERIC_ACTION_14 - GENERIC_ACTION_140 - GENERIC_ACTION_141 - GENERIC_ACTION_142 - GENERIC_ACTION_143 - GENERIC_ACTION_144 - GENERIC_ACTION_145 - GENERIC_ACTION_146 - GENERIC_ACTION_147 - GENERIC_ACTION_148 - GENERIC_ACTION_149 - GENERIC_ACTION_15 - GENERIC_ACTION_150 - GENERIC_ACTION_151 - GENERIC_ACTION_152 - GENERIC_ACTION_153 - GENERIC_ACTION_154 - GENERIC_ACTION_155 - GENERIC_ACTION_156 - GENERIC_ACTION_157 - GENERIC_ACTION_158 - GENERIC_ACTION_159 - GENERIC_ACTION_16 - GENERIC_ACTION_160 - GENERIC_ACTION_161 - GENERIC_ACTION_162 - GENERIC_ACTION_163 - GENERIC_ACTION_164 - GENERIC_ACTION_165 - GENERIC_ACTION_166 - GENERIC_ACTION_167 - GENERIC_ACTION_168 - GENERIC_ACTION_169 - GENERIC_ACTION_17 - GENERIC_ACTION_170 - GENERIC_ACTION_171 - GENERIC_ACTION_172 - GENERIC_ACTION_173 - GENERIC_ACTION_174 - GENERIC_ACTION_175 - GENERIC_ACTION_176 - GENERIC_ACTION_177 - GENERIC_ACTION_178 - GENERIC_ACTION_179 - GENERIC_ACTION_18 - GENERIC_ACTION_180 - GENERIC_ACTION_181 - GENERIC_ACTION_182 - GENERIC_ACTION_183 - GENERIC_ACTION_184 - GENERIC_ACTION_185 - GENERIC_ACTION_186 - GENERIC_ACTION_187 - GENERIC_ACTION_188 - GENERIC_ACTION_189 - GENERIC_ACTION_19 - GENERIC_ACTION_190 - GENERIC_ACTION_191 - GENERIC_ACTION_192 - GENERIC_ACTION_193 - GENERIC_ACTION_194 - GENERIC_ACTION_195 - GENERIC_ACTION_196 - GENERIC_ACTION_197 - GENERIC_ACTION_198 - GENERIC_ACTION_199 - GENERIC_ACTION_2 - GENERIC_ACTION_20 - GENERIC_ACTION_200 - GENERIC_ACTION_21 - GENERIC_ACTION_22 - GENERIC_ACTION_23 - GENERIC_ACTION_24 - GENERIC_ACTION_25 - GENERIC_ACTION_26 - GENERIC_ACTION_27 - GENERIC_ACTION_28 - GENERIC_ACTION_29 - GENERIC_ACTION_3 - GENERIC_ACTION_30 - GENERIC_ACTION_31 - GENERIC_ACTION_32 - GENERIC_ACTION_33 - GENERIC_ACTION_34 - GENERIC_ACTION_35 - GENERIC_ACTION_36 - GENERIC_ACTION_37 - GENERIC_ACTION_38 - GENERIC_ACTION_39 - GENERIC_ACTION_4 - GENERIC_ACTION_40 - GENERIC_ACTION_41 - GENERIC_ACTION_42 - GENERIC_ACTION_43 - GENERIC_ACTION_44 - GENERIC_ACTION_45 - GENERIC_ACTION_46 - GENERIC_ACTION_47 - GENERIC_ACTION_48 - GENERIC_ACTION_49 - GENERIC_ACTION_5 - GENERIC_ACTION_50 - GENERIC_ACTION_51 - GENERIC_ACTION_52 - GENERIC_ACTION_53 - GENERIC_ACTION_54 - GENERIC_ACTION_55 - GENERIC_ACTION_56 - GENERIC_ACTION_57 - GENERIC_ACTION_58 - GENERIC_ACTION_59 - GENERIC_ACTION_6 - GENERIC_ACTION_60 - GENERIC_ACTION_61 - GENERIC_ACTION_62 - GENERIC_ACTION_63 - GENERIC_ACTION_64 - GENERIC_ACTION_65 - GENERIC_ACTION_66 - GENERIC_ACTION_67 - GENERIC_ACTION_68 - GENERIC_ACTION_69 - GENERIC_ACTION_7 - GENERIC_ACTION_70 - GENERIC_ACTION_71 - GENERIC_ACTION_72 - GENERIC_ACTION_73 - GENERIC_ACTION_74 - GENERIC_ACTION_75 - GENERIC_ACTION_76 - GENERIC_ACTION_77 - GENERIC_ACTION_78 - GENERIC_ACTION_79 - GENERIC_ACTION_8 - GENERIC_ACTION_80 - GENERIC_ACTION_81 - GENERIC_ACTION_82 - GENERIC_ACTION_83 - GENERIC_ACTION_84 - GENERIC_ACTION_85 - GENERIC_ACTION_86 - GENERIC_ACTION_87 - GENERIC_ACTION_88 - GENERIC_ACTION_89 - GENERIC_ACTION_9 - GENERIC_ACTION_90 - GENERIC_ACTION_91 - GENERIC_ACTION_92 - GENERIC_ACTION_93 - GENERIC_ACTION_94 - GENERIC_ACTION_95 - GENERIC_ACTION_96 - GENERIC_ACTION_97 - GENERIC_ACTION_98 - GENERIC_ACTION_99 - IMPRESSION - PROMOTION - PURCHASE - REGISTER - SHARE - SHARE_REWARD - THEME_GENERIC_ACTION_1 - THEME_GENERIC_ACTION_10 - THEME_GENERIC_ACTION_11 - THEME_GENERIC_ACTION_12 - THEME_GENERIC_ACTION_13 - THEME_GENERIC_ACTION_14 - THEME_GENERIC_ACTION_15 - THEME_GENERIC_ACTION_16 - THEME_GENERIC_ACTION_17 - THEME_GENERIC_ACTION_18 - THEME_GENERIC_ACTION_19 - THEME_GENERIC_ACTION_2 - THEME_GENERIC_ACTION_20 - THEME_GENERIC_ACTION_21 - THEME_GENERIC_ACTION_22 - THEME_GENERIC_ACTION_23 - THEME_GENERIC_ACTION_24 - THEME_GENERIC_ACTION_25 - THEME_GENERIC_ACTION_26 - THEME_GENERIC_ACTION_27 - THEME_GENERIC_ACTION_28 - THEME_GENERIC_ACTION_29 - THEME_GENERIC_ACTION_3 - THEME_GENERIC_ACTION_30 - THEME_GENERIC_ACTION_4 - THEME_GENERIC_ACTION_5 - THEME_GENERIC_ACTION_6 - THEME_GENERIC_ACTION_7 - THEME_GENERIC_ACTION_8 - THEME_GENERIC_ACTION_9 title: Static Value type: string - description: >- Handlebars expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: handlebars@runtime:{{eventType}} externalDocs: description: IncentivizeStatusUpdateActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: javascript@runtime:function() { return context.get('eventType');} externalDocs: description: IncentivizeStatusUpdateActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string LegacyActionIdInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse: description: >- The legacy action id as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal legacy action id title: Static Value type: string - description: >- Handlebars expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: handlebars@runtime:{{legacyActionId}} externalDocs: description: IncentivizeStatusUpdateActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: >- javascript@runtime:function() { return context.get('legacyActionId');} externalDocs: description: IncentivizeStatusUpdateActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string MessageInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse: description: >- The message as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal message title: Static Value type: string - description: >- Handlebars expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: handlebars@runtime:{{message}} externalDocs: description: IncentivizeStatusUpdateActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: javascript@runtime:function() { return context.get('message');} externalDocs: description: IncentivizeStatusUpdateActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string PartnerEventIdInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse: description: >- The partner event id as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal partner event id title: Static Value type: string - description: >- Handlebars expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: handlebars@runtime:{{partnerEventId}} externalDocs: description: IncentivizeStatusUpdateActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: >- javascript@runtime:function() { return context.get('partnerEventId');} externalDocs: description: IncentivizeStatusUpdateActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string ReviewStatusInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse: description: >- The review status as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@runtime:.* type: string - pattern: ^javascript@runtime:.* type: string type: string description: Literal review status title: Static Value - description: >- Handlebars expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: handlebars@runtime:{{reviewStatus}} externalDocs: description: IncentivizeStatusUpdateActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: javascript@runtime:function() { return context.get('reviewStatus');} externalDocs: description: IncentivizeStatusUpdateActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DataMapInBuiltCampaignControllerActionScheduleResponse: additionalProperties: $ref: >- #/components/schemas/DataInBuiltCampaignControllerActionScheduleResponse type: object DatesInBuiltCampaignControllerActionScheduleResponse: description: >- The dates as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal dates items: $ref: '#/components/schemas/ZonedDateTime' title: Static Value type: array - description: >- Handlebars expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: handlebars@runtime:{{dates}} externalDocs: description: ScheduleActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: javascript@runtime:function() { return context.get('dates');} externalDocs: description: ScheduleActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DelaysInBuiltCampaignControllerActionScheduleResponse: description: >- The delays as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal delays items: $ref: '#/components/schemas/Duration' title: Static Value type: array - description: >- Handlebars expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: handlebars@runtime:{{delays}} externalDocs: description: ScheduleActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: javascript@runtime:function() { return context.get('delays');} externalDocs: description: ScheduleActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string ExtraDataInBuiltCampaignControllerActionScheduleResponse: description: >- The extra data as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - additionalProperties: type: object description: Literal extra data title: Static Value type: object - description: >- Handlebars expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: handlebars@runtime:{{extraData}} externalDocs: description: ScheduleActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: javascript@runtime:function() { return context.get('extraData');} externalDocs: description: ScheduleActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string ScheduleNameInBuiltCampaignControllerActionScheduleResponse: description: >- The schedule name as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@runtime:.* type: string - pattern: ^javascript@runtime:.* type: string type: string description: Literal schedule name title: Static Value - description: >- Handlebars expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: handlebars@runtime:{{scheduleName}} externalDocs: description: ScheduleActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: javascript@runtime:function() { return context.get('scheduleName');} externalDocs: description: ScheduleActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DataMapInBuiltCampaignControllerActionSignalResponse: additionalProperties: $ref: '#/components/schemas/DataInBuiltCampaignControllerActionSignalResponse' type: object NameInBuiltCampaignControllerActionSignalResponse: description: >- The name as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@runtime:.* type: string - pattern: ^javascript@runtime:.* type: string type: string description: Literal name title: Static Value - description: >- Handlebars expression with [SignalActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts). example: handlebars@runtime:{{name}} externalDocs: description: SignalActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [SignalActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts). example: javascript@runtime:function() { return context.get('name');} externalDocs: description: SignalActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string SignalPollingIdInBuiltCampaignControllerActionSignalResponse: description: >- The signal polling id as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@runtime:.* type: string - pattern: ^javascript@runtime:.* type: string type: string description: Literal signal polling id title: Static Value - description: >- Handlebars expression with [SignalActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts). example: handlebars@runtime:{{signalPollingId}} externalDocs: description: SignalActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [SignalActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts). example: >- javascript@runtime:function() { return context.get('signalPollingId');} externalDocs: description: SignalActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DataMapInBuiltCampaignControllerActionWebhookResponse: additionalProperties: $ref: >- #/components/schemas/DataInBuiltCampaignControllerActionWebhookResponse type: object DefaultInBuiltComponentSettingValues: description: >- Example value key. Fallback when no locale- or environment-specific key matches. Omitting `default` is valid when another key applies. oneOf: - description: Literal default title: Static Value type: object - description: >- Handlebars expression with one of the contexts: [ApproveActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/approve/ApproveActionContext.d.ts), [AudienceMembershipTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/audience/membership/AudienceMembershipTriggerContext.d.ts), [ClientWebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/ClientWebhookRuntimeContext.d.ts), [ConsumerWebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/ConsumerWebhookRuntimeContext.d.ts), [CreativeActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/creative/CreativeActionContext.d.ts), [DisplayActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts), [DisplayActionResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionResponseContext.d.ts), [EmailActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.d.ts), [ExpressionActionCommandContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionCommandContext.d.ts), [ExpressionActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionContext.d.ts), [ExpressionTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/expression/ExpressionTriggerContext.d.ts), [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts), [HasPriorRewardTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/reward/HasPriorRewardTriggerContext.d.ts), [HasPriorStepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts), [IncentivizeActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/IncentivizeActionContext.d.ts), [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts), [JourneyKeyContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/journey/JourneyKeyContext.d.ts), [LegacyQualityRuleTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/legacy/quality/LegacyQualityRuleTriggerContext.d.ts), [PartnerWebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/PartnerWebhookRuntimeContext.d.ts), [PrehandlerActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerActionContext.d.ts), [PrehandlerConditionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerConditionContext.d.ts), [PrehandlerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerContext.d.ts), [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts), [RewardHasPriorRewardTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/reward/RewardHasPriorRewardTriggerContext.d.ts), [RewardWebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/reward/RewardWebhookRuntimeContext.d.ts), [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts), [SignalActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts), [StepActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/StepActionContext.d.ts), [StepBuilderContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/builder/StepBuilderContext.d.ts), [StepContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/StepContext.d.ts), [StepDataContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/data/StepDataContext.d.ts), [StepHasPriorStepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/StepHasPriorStepTriggerContext.d.ts), [StepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/StepTriggerContext.d.ts), [VariableRuntimeCreativeActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/runtime/VariableRuntimeCreativeActionContext.d.ts), [WebhookActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/webhook/WebhookActionContext.d.ts), [WebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/WebhookRuntimeContext.d.ts). example: handlebars@runtime:{{default}} pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with one of the contexts: [ApproveActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/approve/ApproveActionContext.d.ts), [AudienceMembershipTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/audience/membership/AudienceMembershipTriggerContext.d.ts), [ClientWebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/ClientWebhookRuntimeContext.d.ts), [ConsumerWebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/ConsumerWebhookRuntimeContext.d.ts), [CreativeActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/creative/CreativeActionContext.d.ts), [DisplayActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts), [DisplayActionResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionResponseContext.d.ts), [EmailActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.d.ts), [ExpressionActionCommandContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionCommandContext.d.ts), [ExpressionActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionContext.d.ts), [ExpressionTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/expression/ExpressionTriggerContext.d.ts), [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts), [HasPriorRewardTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/reward/HasPriorRewardTriggerContext.d.ts), [HasPriorStepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts), [IncentivizeActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/IncentivizeActionContext.d.ts), [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts), [JourneyKeyContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/journey/JourneyKeyContext.d.ts), [LegacyQualityRuleTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/legacy/quality/LegacyQualityRuleTriggerContext.d.ts), [PartnerWebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/PartnerWebhookRuntimeContext.d.ts), [PrehandlerActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerActionContext.d.ts), [PrehandlerConditionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerConditionContext.d.ts), [PrehandlerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerContext.d.ts), [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts), [RewardHasPriorRewardTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/reward/RewardHasPriorRewardTriggerContext.d.ts), [RewardWebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/reward/RewardWebhookRuntimeContext.d.ts), [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts), [SignalActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts), [StepActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/StepActionContext.d.ts), [StepBuilderContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/builder/StepBuilderContext.d.ts), [StepContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/StepContext.d.ts), [StepDataContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/data/StepDataContext.d.ts), [StepHasPriorStepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/StepHasPriorStepTriggerContext.d.ts), [StepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/StepTriggerContext.d.ts), [VariableRuntimeCreativeActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/runtime/VariableRuntimeCreativeActionContext.d.ts), [WebhookActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/webhook/WebhookActionContext.d.ts), [WebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/WebhookRuntimeContext.d.ts). example: javascript@runtime:function() { return context.get('default');} pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string EnInBuiltComponentSettingValues: description: >- Example locale value key. Use any locale or environment code as the key; `en` is shown only as a representative example. oneOf: - description: Literal en title: Static Value type: object - description: >- Handlebars expression with one of the contexts: [ApproveActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/approve/ApproveActionContext.d.ts), [AudienceMembershipTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/audience/membership/AudienceMembershipTriggerContext.d.ts), [ClientWebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/ClientWebhookRuntimeContext.d.ts), [ConsumerWebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/ConsumerWebhookRuntimeContext.d.ts), [CreativeActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/creative/CreativeActionContext.d.ts), [DisplayActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts), [DisplayActionResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionResponseContext.d.ts), [EmailActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.d.ts), [ExpressionActionCommandContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionCommandContext.d.ts), [ExpressionActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionContext.d.ts), [ExpressionTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/expression/ExpressionTriggerContext.d.ts), [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts), [HasPriorRewardTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/reward/HasPriorRewardTriggerContext.d.ts), [HasPriorStepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts), [IncentivizeActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/IncentivizeActionContext.d.ts), [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts), [JourneyKeyContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/journey/JourneyKeyContext.d.ts), [LegacyQualityRuleTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/legacy/quality/LegacyQualityRuleTriggerContext.d.ts), [PartnerWebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/PartnerWebhookRuntimeContext.d.ts), [PrehandlerActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerActionContext.d.ts), [PrehandlerConditionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerConditionContext.d.ts), [PrehandlerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerContext.d.ts), [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts), [RewardHasPriorRewardTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/reward/RewardHasPriorRewardTriggerContext.d.ts), [RewardWebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/reward/RewardWebhookRuntimeContext.d.ts), [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts), [SignalActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts), [StepActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/StepActionContext.d.ts), [StepBuilderContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/builder/StepBuilderContext.d.ts), [StepContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/StepContext.d.ts), [StepDataContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/data/StepDataContext.d.ts), [StepHasPriorStepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/StepHasPriorStepTriggerContext.d.ts), [StepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/StepTriggerContext.d.ts), [VariableRuntimeCreativeActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/runtime/VariableRuntimeCreativeActionContext.d.ts), [WebhookActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/webhook/WebhookActionContext.d.ts), [WebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/WebhookRuntimeContext.d.ts). example: handlebars@runtime:{{en}} pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with one of the contexts: [ApproveActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/approve/ApproveActionContext.d.ts), [AudienceMembershipTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/audience/membership/AudienceMembershipTriggerContext.d.ts), [ClientWebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/ClientWebhookRuntimeContext.d.ts), [ConsumerWebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/ConsumerWebhookRuntimeContext.d.ts), [CreativeActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/creative/CreativeActionContext.d.ts), [DisplayActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionContext.d.ts), [DisplayActionResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/display/DisplayActionResponseContext.d.ts), [EmailActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.d.ts), [ExpressionActionCommandContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionCommandContext.d.ts), [ExpressionActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionContext.d.ts), [ExpressionTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/expression/ExpressionTriggerContext.d.ts), [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts), [HasPriorRewardTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/reward/HasPriorRewardTriggerContext.d.ts), [HasPriorStepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts), [IncentivizeActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/IncentivizeActionContext.d.ts), [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts), [JourneyKeyContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/journey/JourneyKeyContext.d.ts), [LegacyQualityRuleTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/legacy/quality/LegacyQualityRuleTriggerContext.d.ts), [PartnerWebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/PartnerWebhookRuntimeContext.d.ts), [PrehandlerActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerActionContext.d.ts), [PrehandlerConditionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerConditionContext.d.ts), [PrehandlerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerContext.d.ts), [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts), [RewardHasPriorRewardTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/reward/RewardHasPriorRewardTriggerContext.d.ts), [RewardWebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/reward/RewardWebhookRuntimeContext.d.ts), [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts), [SignalActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts), [StepActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/StepActionContext.d.ts), [StepBuilderContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/builder/StepBuilderContext.d.ts), [StepContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/StepContext.d.ts), [StepDataContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/data/StepDataContext.d.ts), [StepHasPriorStepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/StepHasPriorStepTriggerContext.d.ts), [StepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/StepTriggerContext.d.ts), [VariableRuntimeCreativeActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/runtime/VariableRuntimeCreativeActionContext.d.ts), [WebhookActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/webhook/WebhookActionContext.d.ts), [WebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/WebhookRuntimeContext.d.ts). example: javascript@runtime:function() { return context.get('en');} pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string SettingFilterResponseBase: properties: type: enum: - COMPONENT_TYPE - EXPRESSION - FACET type: string type: object ExpressionInExpressionSettingFilterResponse: description: >- The expression as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal expression title: Static Value type: boolean - description: >- Handlebars expression with [SettingFilterBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/SettingFilterBuildtimeContext.d.ts). example: handlebars@buildtime:{{expression}} externalDocs: description: SettingFilterBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/SettingFilterBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [SettingFilterBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/SettingFilterBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('expression');} externalDocs: description: SettingFilterBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/SettingFilterBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string BuiltCampaignControllerTriggerResponseBase: properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceResponse' type: array enabled: type: boolean negated: type: boolean parent_trigger_group_name: type: string trigger_description: type: string trigger_id: type: string trigger_name: type: string trigger_phase: enum: - MATCHING - QUALIFYING - QUALITY type: string trigger_type: enum: - ACCESS - AUDIENCE_MEMBERSHIP - AUDIENCE_MEMBERSHIP_EVENT - CLIENT_DOMAIN - DATA_INTELLIGENCE_EVENT - EVENT - EVENT_TARGETING - EXPRESSION - GROUP - HAS_IDENTITY - HAS_PRIOR_REWARD - HAS_PRIOR_STEP - JOURNEY_CHECK - LEGACY_LABEL_TARGETING - LEGACY_QUALITY - MAXMIND - REFERRED_BY_EVENT - REWARD_EVENT - SCORE - SEND_REWARD_EVENT - SHARE - STEP_EVENT - STICKY_JOURNEY - TARGETING - ZONE_STATE type: string type: object PersonIdInBuiltCampaignControllerTriggerAudienceMembershipResponse: description: >- The person id as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal person id title: Static Value type: string - description: >- Handlebars expression with [AudienceMembershipTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/audience/membership/AudienceMembershipTriggerContext.d.ts). example: handlebars@runtime:{{personId}} externalDocs: description: AudienceMembershipTriggerContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/audience/membership/AudienceMembershipTriggerContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [AudienceMembershipTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/audience/membership/AudienceMembershipTriggerContext.d.ts). example: javascript@runtime:function() { return context.get('personId');} externalDocs: description: AudienceMembershipTriggerContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/audience/membership/AudienceMembershipTriggerContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string ExpressionInBuiltCampaignControllerTriggerExpressionResponse: description: >- The expression as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal expression title: Static Value type: boolean - description: >- Handlebars expression with [ExpressionTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/expression/ExpressionTriggerContext.d.ts). example: handlebars@runtime:{{expression}} externalDocs: description: ExpressionTriggerContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/expression/ExpressionTriggerContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [ExpressionTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/expression/ExpressionTriggerContext.d.ts). example: javascript@runtime:function() { return context.get('expression');} externalDocs: description: ExpressionTriggerContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/expression/ExpressionTriggerContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string MonthDay: description: >- [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#appendix-A) month-day date. example: '--10-24' pattern: ^--(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])$ type: string FilterCampaignIdsInBuiltCampaignControllerTriggerHasPriorStepResponse: description: >- The filter campaign ids as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal filter campaign ids items: type: string title: Static Value type: array uniqueItems: true - description: >- Handlebars expression with [HasPriorStepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts). example: handlebars@runtime:{{filterCampaignIds}} externalDocs: description: HasPriorStepTriggerContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [HasPriorStepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts). example: >- javascript@runtime:function() { return context.get('filterCampaignIds');} externalDocs: description: HasPriorStepTriggerContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string FilterExpressionInBuiltCampaignControllerTriggerHasPriorStepResponse: description: >- The filter expression as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal filter expression title: Static Value type: boolean - description: >- Handlebars expression with [StepHasPriorStepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/StepHasPriorStepTriggerContext.d.ts). example: handlebars@runtime:{{filterExpression}} externalDocs: description: StepHasPriorStepTriggerContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/StepHasPriorStepTriggerContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [StepHasPriorStepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/StepHasPriorStepTriggerContext.d.ts). example: >- javascript@runtime:function() { return context.get('filterExpression');} externalDocs: description: StepHasPriorStepTriggerContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/StepHasPriorStepTriggerContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string PartnerEventId: properties: name: type: string value: type: string type: object FilterProgramLabelsInBuiltCampaignControllerTriggerHasPriorStepResponse: description: >- The filter program labels as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal filter program labels items: type: string title: Static Value type: array uniqueItems: true - description: >- Handlebars expression with [HasPriorStepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts). example: handlebars@runtime:{{filterProgramLabels}} externalDocs: description: HasPriorStepTriggerContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [HasPriorStepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts). example: >- javascript@runtime:function() { return context.get('filterProgramLabels');} externalDocs: description: HasPriorStepTriggerContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string HavingAllNamesInBuiltCampaignControllerTriggerHasPriorStepResponse: description: >- The having all names as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal having all names items: type: string title: Static Value type: array uniqueItems: true - description: >- Handlebars expression with [HasPriorStepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts). example: handlebars@runtime:{{havingAllNames}} externalDocs: description: HasPriorStepTriggerContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [HasPriorStepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts). example: >- javascript@runtime:function() { return context.get('havingAllNames');} externalDocs: description: HasPriorStepTriggerContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string PersonIdInBuiltCampaignControllerTriggerHasPriorStepResponse: description: >- The person id as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal person id title: Static Value type: string - description: >- Handlebars expression with [HasPriorStepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts). example: handlebars@runtime:{{personId}} externalDocs: description: HasPriorStepTriggerContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [HasPriorStepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts). example: javascript@runtime:function() { return context.get('personId');} externalDocs: description: HasPriorStepTriggerContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/has/prior/step/HasPriorStepTriggerContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string PersonIdInBuiltCampaignControllerTriggerJourneyCheckResponse: description: >- The person id as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal person id title: Static Value type: string - description: >- Handlebars expression with [StepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/StepTriggerContext.d.ts). example: handlebars@runtime:{{personId}} externalDocs: description: StepTriggerContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/StepTriggerContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [StepTriggerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/StepTriggerContext.d.ts). example: javascript@runtime:function() { return context.get('personId');} externalDocs: description: StepTriggerContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/trigger/StepTriggerContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string ApiResponse: properties: body: type: string headers: additionalProperties: type: string type: object statusCode: format: int32 type: integer type: object DataInBuiltCampaignControllerActionEarnRewardResponse: description: >- The data as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal data title: Static Value type: object - description: >- Handlebars expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: RewardActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [RewardActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: RewardActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/reward/RewardActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DataInBuiltCampaignControllerActionEmailResponse: description: >- The data as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal data title: Static Value type: object - description: >- Handlebars expression with [EmailActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: EmailActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [EmailActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: EmailActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/email/EmailActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DataInBuiltCampaignControllerActionExpressionResponse: description: >- The data as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal data title: Static Value type: object - description: >- Handlebars expression with [ExpressionActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: ExpressionActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [ExpressionActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: ExpressionActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/expression/ExpressionActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string EmailFireAsPersonIdentification: allOf: - $ref: '#/components/schemas/FireAsPersonIdentificationBase' - properties: person_identification_type: enum: - EMAIL type: string type: object title: EMAIL PartnerEventIdFireAsPersonIdentification: allOf: - $ref: '#/components/schemas/FireAsPersonIdentificationBase' - properties: partner_event_key: type: string person_identification_type: enum: - PARTNER_EVENT_ID type: string type: object type: object title: PARTNER_EVENT_ID PartnerUserIdFireAsPersonIdentification: allOf: - $ref: '#/components/schemas/FireAsPersonIdentificationBase' - properties: person_identification_type: enum: - PARTNER_USER_ID type: string type: object title: PARTNER_USER_ID PersonIdFireAsPersonIdentification: allOf: - $ref: '#/components/schemas/FireAsPersonIdentificationBase' - properties: person_identification_type: enum: - PERSON_ID type: string type: object title: PERSON_ID DataInBuiltCampaignControllerActionFireAsPersonResponse: description: >- The data as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal data title: Static Value type: object - description: >- Handlebars expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: FireAsPersonActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [FireAsPersonActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: FireAsPersonActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/fire/as/person/FireAsPersonActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DataInBuiltCampaignControllerActionIncentivizeResponse: description: >- The data as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal data title: Static Value type: object - description: >- Handlebars expression with [IncentivizeActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/IncentivizeActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: IncentivizeActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/IncentivizeActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [IncentivizeActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/IncentivizeActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: IncentivizeActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/IncentivizeActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DataInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse: description: >- The data as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal data title: Static Value type: object - description: >- Handlebars expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: IncentivizeStatusUpdateActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [IncentivizeStatusUpdateActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: IncentivizeStatusUpdateActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/incentivize/status/update/IncentivizeStatusUpdateActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DataInBuiltCampaignControllerActionScheduleResponse: description: >- The data as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal data title: Static Value type: object - description: >- Handlebars expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: ScheduleActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [ScheduleActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: ScheduleActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/schedule/ScheduleActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DataInBuiltCampaignControllerActionSignalResponse: description: >- The data as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal data title: Static Value type: object - description: >- Handlebars expression with [SignalActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: SignalActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [SignalActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: SignalActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/signal/SignalActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DataInBuiltCampaignControllerActionWebhookResponse: description: >- The data as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal data title: Static Value type: object - description: >- Handlebars expression with [WebhookActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/webhook/WebhookActionContext.d.ts). example: handlebars@runtime:{{data}} externalDocs: description: WebhookActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/webhook/WebhookActionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [WebhookActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/webhook/WebhookActionContext.d.ts). example: javascript@runtime:function() { return context.get('data');} externalDocs: description: WebhookActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/action/webhook/WebhookActionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string FireAsPersonIdentificationBase: properties: person_identification_type: enum: - EMAIL - PARTNER_EVENT_ID - PARTNER_USER_ID - PERSON_ID type: string value: type: string type: object examples: binding_error: summary: binding_error value: code: binding_error http_status_code: 400 message: Argument is not of the expected type parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_build_failed: summary: campaign_build_failed value: code: campaign_build_failed http_status_code: 400 message: Campaign build failed parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_concurrent_update: summary: campaign_concurrent_update value: code: campaign_concurrent_update http_status_code: 400 message: >- Could not perform the operation. Campaign is currently updated by other process/user parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_has_pending_changes: summary: campaign_has_pending_changes value: code: campaign_has_pending_changes http_status_code: 400 message: Could not perform the operation. Campaign has pending changes parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_locked: summary: campaign_locked value: code: campaign_locked http_status_code: 400 message: Could not perform the operation. The campaign is locked parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_version_malformed: summary: campaign_version_malformed value: code: campaign_version_malformed http_status_code: 400 message: Campaign version is malformed parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 controller_state_misconfiguration: summary: controller_state_misconfiguration value: code: controller_state_misconfiguration http_status_code: 400 message: A controller has not properly configured state parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 date_invalid: summary: date_invalid value: code: date_invalid http_status_code: 400 message: Date is invalid or not ISO-8601 compliant parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 expression_invalid_syntax: summary: expression_invalid_syntax value: code: expression_invalid_syntax http_status_code: 400 message: Campaign build failed due expression invalid syntax parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_campaign_id: summary: invalid_campaign_id value: code: invalid_campaign_id http_status_code: 400 message: Invalid Campaign Id parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_campaign_state: summary: invalid_campaign_state value: code: invalid_campaign_state http_status_code: 400 message: Invalid campaign state parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_campaign_version: summary: invalid_campaign_version value: code: invalid_campaign_version http_status_code: 400 message: Invalid Campaign Version parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_json: summary: invalid_json value: code: invalid_json http_status_code: 400 message: JSON is invalid parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_parameter: summary: invalid_parameter value: code: invalid_parameter http_status_code: 400 message: Parameter is invalid. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 lock_missing_lock_types: summary: lock_missing_lock_types value: code: lock_missing_lock_types http_status_code: 400 message: Unable to unlock, lock types should be specified parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 missing_request_body: summary: missing_request_body value: code: missing_request_body http_status_code: 400 message: Missing request body parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 rebuild_campaigns_build_failed: summary: rebuild_campaigns_build_failed value: code: rebuild_campaigns_build_failed http_status_code: 400 message: Rebuild campaigns build failed parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 unlock_missing_lock_types: summary: unlock_missing_lock_types value: code: unlock_missing_lock_types http_status_code: 400 message: Unable to lock, lock types should be specified parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 method_unauthorized: summary: method_unauthorized value: code: method_unauthorized http_status_code: 401 message: Unauthorized access to this endpoint parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 payment_required: summary: payment_required value: code: payment_required http_status_code: 402 message: The access_token provided is associated with an unpaid account. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 access_denied: summary: access_denied value: code: access_denied http_status_code: 403 message: >- The access_token provided is not permitted to access the specified resource. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 missing_access_token: summary: missing_access_token value: code: missing_access_token http_status_code: 403 message: No access_token was provided with this request. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 unsupported_media_type: summary: unsupported_media_type value: code: unsupported_media_type http_status_code: 415 message: Request had an unsupported or no media type parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 too_many_requests: summary: too_many_requests value: code: too_many_requests http_status_code: 429 message: >- The server is unable to process your request at the moment, please retry later. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 securitySchemes: HEADER: in: header name: Authorization type: apiKey x-bearer-format: bearer QUERY: in: query name: access_token type: apiKey COOKIE: in: cookie name: extole_token type: apiKey ````