Class: UltracartClient::EmailSegment

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/models/email_segment.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EmailSegment

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/ultracart_api/models/email_segment.rb', line 136

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'allow_csv_download')
    self.allow_csv_download = attributes[:'allow_csv_download']
  end

  if attributes.has_key?(:'allow_facebook_audiences')
    self.allow_facebook_audiences = attributes[:'allow_facebook_audiences']
  end

  if attributes.has_key?(:'created_dts')
    self.created_dts = attributes[:'created_dts']
  end

  if attributes.has_key?(:'deleted')
    self.deleted = attributes[:'deleted']
  end

  if attributes.has_key?(:'email_segment_uuid')
    self.email_segment_uuid = attributes[:'email_segment_uuid']
  end

  if attributes.has_key?(:'esp_list_segment_folder_uuid')
    self.esp_list_segment_folder_uuid = attributes[:'esp_list_segment_folder_uuid']
  end

  if attributes.has_key?(:'facebook_custom_audience')
    self.facebook_custom_audience = attributes[:'facebook_custom_audience']
  end

  if attributes.has_key?(:'filter_profile_equation_json')
    self.filter_profile_equation_json = attributes[:'filter_profile_equation_json']
  end

  if attributes.has_key?(:'member_count')
    self.member_count = attributes[:'member_count']
  end

  if attributes.has_key?(:'merchant_id')
    self.merchant_id = attributes[:'merchant_id']
  end

  if attributes.has_key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.has_key?(:'rank_json')
    self.rank_json = attributes[:'rank_json']
  end

  if attributes.has_key?(:'rebuild_required')
    self.rebuild_required = attributes[:'rebuild_required']
  end

  if attributes.has_key?(:'storefront_oid')
    self.storefront_oid = attributes[:'storefront_oid']
  end

  if attributes.has_key?(:'thirdparty_join_add_tags')
    if (value = attributes[:'thirdparty_join_add_tags']).is_a?(Array)
      self.thirdparty_join_add_tags = value
    end
  end

  if attributes.has_key?(:'thirdparty_join_remove_tags')
    if (value = attributes[:'thirdparty_join_remove_tags']).is_a?(Array)
      self.thirdparty_join_remove_tags = value
    end
  end

  if attributes.has_key?(:'thirdparty_leave_add_tags')
    if (value = attributes[:'thirdparty_leave_add_tags']).is_a?(Array)
      self.thirdparty_leave_add_tags = value
    end
  end

  if attributes.has_key?(:'thirdparty_leave_remove_tags')
    if (value = attributes[:'thirdparty_leave_remove_tags']).is_a?(Array)
      self.thirdparty_leave_remove_tags = value
    end
  end

  if attributes.has_key?(:'thirdparty_list_id')
    self.thirdparty_list_id = attributes[:'thirdparty_list_id']
  end

  if attributes.has_key?(:'thirdparty_provider_name')
    self.thirdparty_provider_name = attributes[:'thirdparty_provider_name']
  end

  if attributes.has_key?(:'used_by')
    if (value = attributes[:'used_by']).is_a?(Array)
      self.used_by = value
    end
  end
end

Instance Attribute Details

#allow_csv_download ⇒ Object

True if the current user has the rights to download this segment.



18
19
20
 
# File 'lib/ultracart_api/models/email_segment.rb', line 18

def allow_csv_download
  @allow_csv_download
end

#allow_facebook_audiences ⇒ Object

True if this StoreFront has the Facebook Analytics app connected and supports them



21
22
23
 
# File 'lib/ultracart_api/models/email_segment.rb', line 21

def allow_facebook_audiences
  @allow_facebook_audiences
end

#created_dts ⇒ Object

Created date



24
25
26
 
# File 'lib/ultracart_api/models/email_segment.rb', line 24

def created_dts
  @created_dts
end

#deleted ⇒ Object

True if this campaign was deleted



27
28
29
 
# File 'lib/ultracart_api/models/email_segment.rb', line 27

def deleted
  @deleted
end

#email_segment_uuid ⇒ Object

Email segment UUID



30
31
32
 
# File 'lib/ultracart_api/models/email_segment.rb', line 30

def email_segment_uuid
  @email_segment_uuid
end

#esp_list_segment_folder_uuid ⇒ Object

List/Segment folder UUID



33
34
35
 
# File 'lib/ultracart_api/models/email_segment.rb', line 33

def esp_list_segment_folder_uuid
  @esp_list_segment_folder_uuid
end

#facebook_custom_audience ⇒ Object

True if you want to sync to a facebook custom audience



36
37
38
 
# File 'lib/ultracart_api/models/email_segment.rb', line 36

def facebook_custom_audience
  @facebook_custom_audience
end

#filter_profile_equation_json ⇒ Object

File profile equation json



39
40
41
 
# File 'lib/ultracart_api/models/email_segment.rb', line 39

def filter_profile_equation_json
  @filter_profile_equation_json
end

#member_count ⇒ Object

Count of members in this segment



42
43
44
 
# File 'lib/ultracart_api/models/email_segment.rb', line 42

def member_count
  @member_count
end

#merchant_id ⇒ Object

Merchant ID



45
46
47
 
# File 'lib/ultracart_api/models/email_segment.rb', line 45

def merchant_id
  @merchant_id
end

#name ⇒ Object

Name of email segment



48
49
50
 
# File 'lib/ultracart_api/models/email_segment.rb', line 48

def name
  @name
end

#rank_json ⇒ Object

Rank settings json



51
52
53
 
# File 'lib/ultracart_api/models/email_segment.rb', line 51

def rank_json
  @rank_json
end

#rebuild_required ⇒ Object

True if a rebuild is required because some part of the segment has changed



54
55
56
 
# File 'lib/ultracart_api/models/email_segment.rb', line 54

def rebuild_required
  @rebuild_required
end

#storefront_oid ⇒ Object

Storefront oid



57
58
59
 
# File 'lib/ultracart_api/models/email_segment.rb', line 57

def storefront_oid
  @storefront_oid
end

#thirdparty_join_add_tags ⇒ Object

Third party provider tags to add when a customer joins the segment.



60
61
62
 
# File 'lib/ultracart_api/models/email_segment.rb', line 60

def thirdparty_join_add_tags
  @thirdparty_join_add_tags
end

#thirdparty_join_remove_tags ⇒ Object

Third party provider tags to remove when a customer joins the segment.



63
64
65
 
# File 'lib/ultracart_api/models/email_segment.rb', line 63

def thirdparty_join_remove_tags
  @thirdparty_join_remove_tags
end

#thirdparty_leave_add_tags ⇒ Object

Third party provider tags to add when a customer leaves the segment.



66
67
68
 
# File 'lib/ultracart_api/models/email_segment.rb', line 66

def thirdparty_leave_add_tags
  @thirdparty_leave_add_tags
end

#thirdparty_leave_remove_tags ⇒ Object

Third party provider tags to remove when a customer leaves the segment.



69
70
71
 
# File 'lib/ultracart_api/models/email_segment.rb', line 69

def thirdparty_leave_remove_tags
  @thirdparty_leave_remove_tags
end

#thirdparty_list_id ⇒ Object

List id of third party provider to sync with.



72
73
74
 
# File 'lib/ultracart_api/models/email_segment.rb', line 72

def thirdparty_list_id
  @thirdparty_list_id
end

#thirdparty_provider_name ⇒ Object

Name of third party provider to sync segment to a list with.



75
76
77
 
# File 'lib/ultracart_api/models/email_segment.rb', line 75

def thirdparty_provider_name
  @thirdparty_provider_name
end

#used_by ⇒ Object

Details on the flows or campaigns that use this list.



78
79
80
 
# File 'lib/ultracart_api/models/email_segment.rb', line 78

def used_by
  @used_by
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/ultracart_api/models/email_segment.rb', line 81

def self.attribute_map
  {
    :'allow_csv_download' => :'allow_csv_download',
    :'allow_facebook_audiences' => :'allow_facebook_audiences',
    :'created_dts' => :'created_dts',
    :'deleted' => :'deleted',
    :'email_segment_uuid' => :'email_segment_uuid',
    :'esp_list_segment_folder_uuid' => :'esp_list_segment_folder_uuid',
    :'facebook_custom_audience' => :'facebook_custom_audience',
    :'filter_profile_equation_json' => :'filter_profile_equation_json',
    :'member_count' => :'member_count',
    :'merchant_id' => :'merchant_id',
    :'name' => :'name',
    :'rank_json' => :'rank_json',
    :'rebuild_required' => :'rebuild_required',
    :'storefront_oid' => :'storefront_oid',
    :'thirdparty_join_add_tags' => :'thirdparty_join_add_tags',
    :'thirdparty_join_remove_tags' => :'thirdparty_join_remove_tags',
    :'thirdparty_leave_add_tags' => :'thirdparty_leave_add_tags',
    :'thirdparty_leave_remove_tags' => :'thirdparty_leave_remove_tags',
    :'thirdparty_list_id' => :'thirdparty_list_id',
    :'thirdparty_provider_name' => :'thirdparty_provider_name',
    :'used_by' => :'used_by'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/ultracart_api/models/email_segment.rb', line 108

def self.swagger_types
  {
    :'allow_csv_download' => :'BOOLEAN',
    :'allow_facebook_audiences' => :'BOOLEAN',
    :'created_dts' => :'String',
    :'deleted' => :'BOOLEAN',
    :'email_segment_uuid' => :'String',
    :'esp_list_segment_folder_uuid' => :'String',
    :'facebook_custom_audience' => :'BOOLEAN',
    :'filter_profile_equation_json' => :'String',
    :'member_count' => :'Integer',
    :'merchant_id' => :'String',
    :'name' => :'String',
    :'rank_json' => :'String',
    :'rebuild_required' => :'BOOLEAN',
    :'storefront_oid' => :'Integer',
    :'thirdparty_join_add_tags' => :'Array<String>',
    :'thirdparty_join_remove_tags' => :'Array<String>',
    :'thirdparty_leave_add_tags' => :'Array<String>',
    :'thirdparty_leave_remove_tags' => :'Array<String>',
    :'thirdparty_list_id' => :'String',
    :'thirdparty_provider_name' => :'String',
    :'used_by' => :'Array<EmailListSegmentUsedBy>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/ultracart_api/models/email_segment.rb', line 267

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      allow_csv_download == o.allow_csv_download &&
      allow_facebook_audiences == o.allow_facebook_audiences &&
      created_dts == o.created_dts &&
      deleted == o.deleted &&
      email_segment_uuid == o.email_segment_uuid &&
      esp_list_segment_folder_uuid == o.esp_list_segment_folder_uuid &&
      facebook_custom_audience == o.facebook_custom_audience &&
      filter_profile_equation_json == o.filter_profile_equation_json &&
      member_count == o.member_count &&
      merchant_id == o.merchant_id &&
      name == o.name &&
      rank_json == o.rank_json &&
      rebuild_required == o.rebuild_required &&
      storefront_oid == o.storefront_oid &&
      thirdparty_join_add_tags == o.thirdparty_join_add_tags &&
      thirdparty_join_remove_tags == o.thirdparty_join_remove_tags &&
      thirdparty_leave_add_tags == o.thirdparty_leave_add_tags &&
      thirdparty_leave_remove_tags == o.thirdparty_leave_remove_tags &&
      thirdparty_list_id == o.thirdparty_list_id &&
      thirdparty_provider_name == o.thirdparty_provider_name &&
      used_by == o.used_by
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/ultracart_api/models/email_segment.rb', line 329

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = UltracartClient.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/ultracart_api/models/email_segment.rb', line 395

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/ultracart_api/models/email_segment.rb', line 308

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


295
296
297
 
# File 'lib/ultracart_api/models/email_segment.rb', line 295

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



301
302
303
 
# File 'lib/ultracart_api/models/email_segment.rb', line 301

def hash
  [allow_csv_download, allow_facebook_audiences, created_dts, deleted, email_segment_uuid, esp_list_segment_folder_uuid, facebook_custom_audience, filter_profile_equation_json, member_count, merchant_id, name, rank_json, rebuild_required, storefront_oid, thirdparty_join_add_tags, thirdparty_join_remove_tags, thirdparty_leave_add_tags, thirdparty_leave_remove_tags, thirdparty_list_id, thirdparty_provider_name, used_by].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



239
240
241
242
243
244
245
246
 
# File 'lib/ultracart_api/models/email_segment.rb', line 239

def list_invalid_properties
  invalid_properties = Array.new
  if !@name.nil? && @name.to_s.length > 250
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 250.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



375
376
377
 
# File 'lib/ultracart_api/models/email_segment.rb', line 375

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



381
382
383
384
385
386
387
388
389
 
# File 'lib/ultracart_api/models/email_segment.rb', line 381

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



369
370
371
 
# File 'lib/ultracart_api/models/email_segment.rb', line 369

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



250
251
252
253
 
# File 'lib/ultracart_api/models/email_segment.rb', line 250

def valid?
  return false if !@name.nil? && @name.to_s.length > 250
  true
end