Sha256: 83a3e2c393380eeb1421b5acca40039da297e9e21eb29e5c3e59cb1b2a8d76d3

Contents?: true

Size: 1.55 KB

Versions: 3

Compression:

Stored size: 1.55 KB

Contents

# TalonOne::Effect

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**campaign_id** | **Integer** | The ID of the campaign that triggered this effect. | 
**ruleset_id** | **Integer** | The ID of the ruleset that was active in the campaign when this effect was triggered. | 
**rule_index** | **Integer** | The position of the rule that triggered this effect within the ruleset. | 
**rule_name** | **String** | The name of the rule that triggered this effect. | 
**effect_type** | **String** | The type of effect that was triggered. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). | 
**triggered_by_coupon** | **Integer** | The ID of the coupon that was being evaluated when this effect was triggered. | [optional] 
**triggered_for_catalog_item** | **Integer** | The ID of the catalog item that was being evaluated when this effect was triggered. | [optional] 
**props** | [**Object**](.md) | The properties of the effect. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). | 

## Code Sample

```ruby
require 'TalonOne'

instance = TalonOne::Effect.new(campaign_id: 244,
                                 ruleset_id: 73,
                                 rule_index: 2,
                                 rule_name: Give 20% discount,
                                 effect_type: rejectCoupon,
                                 triggered_by_coupon: 4928,
                                 triggered_for_catalog_item: 786,
                                 props: null)
```


Version data entries

3 entries across 3 versions & 1 rubygems

Version Path
talon_one-3.0.2 docs/Effect.md
talon_one-3.0.1 docs/Effect.md
talon_one-3.0.0 docs/Effect.md