Class: KlaviyoAPI::FlowSeriesRequestDTOResourceObjectAttributes

Inherits:
Object
  • Object
show all
Defined in:
lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FlowSeriesRequestDTOResourceObjectAttributes

Initializes the object

Parameters:

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

    Model attributes in the form of hash



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes.rb', line 90

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::FlowSeriesRequestDTOResourceObjectAttributes` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `KlaviyoAPI::FlowSeriesRequestDTOResourceObjectAttributes`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

  if attributes.key?(:'timeframe')
    self.timeframe = attributes[:'timeframe']
  end

  if attributes.key?(:'interval')
    self.interval = attributes[:'interval']
  end

  if attributes.key?(:'conversion_metric_id')
    self.conversion_metric_id = attributes[:'conversion_metric_id']
  end

  if attributes.key?(:'filter')
    self.filter = attributes[:'filter']
  end
end

Instance Attribute Details

#conversion_metric_id ⇒ Object

ID of the metric to be used for conversion statistics



27
28
29
 
# File 'lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes.rb', line 27

def conversion_metric_id
  @conversion_metric_id
end

#filter ⇒ Object

API filter string used to filter the query. Allowed filters are flow_id, send_channel, flow_message_id. Allowed operators are equals, contains-any. Only one filter can be used per attribute, only AND can be used as a combination operator. Max of 100 messages per ANY filter. When filtering on send_channel, allowed values are email, push-notification, sms, whatsapp.



30
31
32
 
# File 'lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes.rb', line 30

def filter
  @filter
end

#interval ⇒ Object

The interval used to aggregate data within the series request. If hourly is used, the timeframe cannot be longer than 7 days. If daily is used, the timeframe cannot be longer than 60 days. If monthly is used, the timeframe cannot be longer than 52 weeks.



24
25
26
 
# File 'lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes.rb', line 24

def interval
  @interval
end

#statistics ⇒ Object

List of statistics to query for. All rate statistics will be returned in fractional form [0.0, 1.0]



19
20
21
 
# File 'lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes.rb', line 19

def statistics
  @statistics
end

#timeframe ⇒ Object

Returns the value of attribute timeframe.



21
22
23
 
# File 'lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes.rb', line 21

def timeframe
  @timeframe
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



66
67
68
 
# File 'lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes.rb', line 66

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
 
# File 'lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes.rb', line 55

def self.attribute_map
  {
    :'statistics' => :'statistics',
    :'timeframe' => :'timeframe',
    :'interval' => :'interval',
    :'conversion_metric_id' => :'conversion_metric_id',
    :'filter' => :'filter'
  }
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



198
199
200
 
# File 'lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes.rb', line 198

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



82
83
84
85
86
 
# File 'lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes.rb', line 82

def self.openapi_nullable
  Set.new([
    :'filter'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
79
 
# File 'lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes.rb', line 71

def self.openapi_types
  {
    :'statistics' => :'Array<String>',
    :'timeframe' => :'CampaignValuesRequestDTOResourceObjectAttributesTimeframe',
    :'interval' => :'String',
    :'conversion_metric_id' => :'String',
    :'filter' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



173
174
175
176
177
178
179
180
181
 
# File 'lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes.rb', line 173

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      statistics == o.statistics &&
      timeframe == o.timeframe &&
      interval == o.interval &&
      conversion_metric_id == o.conversion_metric_id &&
      filter == o.filter
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



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes.rb', line 229

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = KlaviyoAPI.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes.rb', line 300

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



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes.rb', line 205

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


185
186
187
 
# File 'lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes.rb', line 185

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



191
192
193
 
# File 'lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes.rb', line 191

def hash
  [statistics, timeframe, interval, conversion_metric_id, filter].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



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes.rb', line 128

def list_invalid_properties
  invalid_properties = Array.new
  if @statistics.nil?
    invalid_properties.push('invalid value for "statistics", statistics cannot be nil.')
  end

  if @timeframe.nil?
    invalid_properties.push('invalid value for "timeframe", timeframe cannot be nil.')
  end

  if @interval.nil?
    invalid_properties.push('invalid value for "interval", interval cannot be nil.')
  end

  if @conversion_metric_id.nil?
    invalid_properties.push('invalid value for "conversion_metric_id", conversion_metric_id cannot be nil.')
  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



276
277
278
 
# File 'lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes.rb', line 276

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



282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes.rb', line 282

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



270
271
272
 
# File 'lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes.rb', line 270

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



151
152
153
154
155
156
157
158
159
 
# File 'lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes.rb', line 151

def valid?
  return false if @statistics.nil?
  return false if @timeframe.nil?
  return false if @interval.nil?
  interval_validator = EnumAttributeValidator.new('String', ["daily", "hourly", "monthly", "weekly"])
  return false unless interval_validator.valid?(@interval)
  return false if @conversion_metric_id.nil?
  true
end