Class: Norbelys::AnalyticsQueryParams

Inherits:
Object
  • Object
show all
Defined in:
lib/norbelys/models/analytics_query_params.rb

Overview

Query parameters; each query reads the subset it supports.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AnalyticsQueryParams

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/norbelys/models/analytics_query_params.rb', line 151

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Norbelys::AnalyticsQueryParams` 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 `Norbelys::AnalyticsQueryParams`. 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?(:'activity')
    self.activity = attributes[:'activity']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#_until ⇒ Object

Window end (ISO 8601).



68
69
70
 
# File 'lib/norbelys/models/analytics_query_params.rb', line 68

def _until
  @_until
end

#activity ⇒ Object

The outbound message id. Required by the message_events query; returns every event for that one send.



20
21
22
 
# File 'lib/norbelys/models/analytics_query_params.rb', line 20

def activity
  @activity
end

#days ⇒ Object

Lookback window in days (alternative to since/until).



23
24
25
 
# File 'lib/norbelys/models/analytics_query_params.rb', line 23

def days
  @days
end

#dir ⇒ Object

Sort direction for activity_feed (default desc).



26
27
28
 
# File 'lib/norbelys/models/analytics_query_params.rb', line 26

def dir
  @dir
end

#domain ⇒ Object

The monitored domain name. Required by dmarc_summary / dmarc_sources; optional on dmarc_reports / dmarc_receivers — omit for the account-wide feed. Example: acme.com



29
30
31
 
# File 'lib/norbelys/models/analytics_query_params.rb', line 29

def domain
  @domain
end

#exclude_machine ⇒ Object

activity_feed only: exclude machine-generated engagement — opens not classified as human (e.g. automated inbox prefetches) and any bot-classified event.



32
33
34
 
# File 'lib/norbelys/models/analytics_query_params.rb', line 32

def exclude_machine
  @exclude_machine
end

#limit ⇒ Object

Max rows returned.



35
36
37
 
# File 'lib/norbelys/models/analytics_query_params.rb', line 35

def limit
  @limit
end

#offset ⇒ Object

Rows to skip (activity_feed paging).



38
39
40
 
# File 'lib/norbelys/models/analytics_query_params.rb', line 38

def offset
  @offset
end

#order_by ⇒ Object

Sort column for activity_feed. Example: occurred_at



41
42
43
 
# File 'lib/norbelys/models/analytics_query_params.rb', line 41

def order_by
  @order_by
end

#person ⇒ Object

Scope to one person (person id). Used by: contact_events.



44
45
46
 
# File 'lib/norbelys/models/analytics_query_params.rb', line 44

def person
  @person
end

#program ⇒ Object

Scope to one campaign (program id). Used by: activity_feed, program_funnel, sender_breakdown, variant_performance.



47
48
49
 
# File 'lib/norbelys/models/analytics_query_params.rb', line 47

def program
  @program
end

#receiver ⇒ Object

Narrow the DMARC queries to ONE reporter (receiver) — 'show me only what Gmail saw'. Used by: dmarc_summary, dmarc_sources, dmarc_geo, dmarc_reports.



50
51
52
 
# File 'lib/norbelys/models/analytics_query_params.rb', line 50

def receiver
  @receiver
end

#search ⇒ Object

Free-text search (activity_feed: matches recipient/subject).



53
54
55
 
# File 'lib/norbelys/models/analytics_query_params.rb', line 53

def search
  @search
end

#sender ⇒ Object

Scope to one sender — by id ("snd_…") or by its from address ("receipts@hola.com"); both filter identically. Used by: activity_feed, sender_health, warmup_placement.



56
57
58
 
# File 'lib/norbelys/models/analytics_query_params.rb', line 56

def sender
  @sender
end

#since ⇒ Object

Window start (ISO 8601). Most queries default to the last 30 days.



59
60
61
 
# File 'lib/norbelys/models/analytics_query_params.rb', line 59

def since
  @since
end

#thread ⇒ Object

A conversation (thread) id — narrows agent_trace to one conversation.



62
63
64
 
# File 'lib/norbelys/models/analytics_query_params.rb', line 62

def thread
  @thread
end

#type ⇒ Object

Filter to one event type.



65
66
67
 
# File 'lib/norbelys/models/analytics_query_params.rb', line 65

def type
  @type
end

Class Method Details

._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



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/norbelys/models/analytics_query_params.rb', line 398

def self._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 = Norbelys.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



116
117
118
 
# File 'lib/norbelys/models/analytics_query_params.rb', line 116

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/norbelys/models/analytics_query_params.rb', line 93

def self.attribute_map
  {
    :'activity' => :'activity',
    :'days' => :'days',
    :'dir' => :'dir',
    :'domain' => :'domain',
    :'exclude_machine' => :'excludeMachine',
    :'limit' => :'limit',
    :'offset' => :'offset',
    :'order_by' => :'orderBy',
    :'person' => :'person',
    :'program' => :'program',
    :'receiver' => :'receiver',
    :'search' => :'search',
    :'sender' => :'sender',
    :'since' => :'since',
    :'thread' => :'thread',
    :'type' => :'type',
    :'_until' => :'until'
  }
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



374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/norbelys/models/analytics_query_params.rb', line 374

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



144
145
146
147
 
# File 'lib/norbelys/models/analytics_query_params.rb', line 144

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/norbelys/models/analytics_query_params.rb', line 121

def self.openapi_types
  {
    :'activity' => :'String',
    :'days' => :'Integer',
    :'dir' => :'String',
    :'domain' => :'String',
    :'exclude_machine' => :'Boolean',
    :'limit' => :'Integer',
    :'offset' => :'Integer',
    :'order_by' => :'String',
    :'person' => :'String',
    :'program' => :'String',
    :'receiver' => :'String',
    :'search' => :'String',
    :'sender' => :'String',
    :'since' => :'String',
    :'thread' => :'String',
    :'type' => :'String',
    :'_until' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/norbelys/models/analytics_query_params.rb', line 337

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      activity == o.activity &&
      days == o.days &&
      dir == o.dir &&
      domain == o.domain &&
      exclude_machine == o.exclude_machine &&
      limit == o.limit &&
      offset == o.offset &&
      order_by == o.order_by &&
      person == o.person &&
      program == o.program &&
      receiver == o.receiver &&
      search == o.search &&
      sender == o.sender &&
      since == o.since &&
      thread == o.thread &&
      type == o.type &&
      _until == o._until
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



469
470
471
472
473
474
475
476
477
478
479
480
481
 
# File 'lib/norbelys/models/analytics_query_params.rb', line 469

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


361
362
363
 
# File 'lib/norbelys/models/analytics_query_params.rb', line 361

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



367
368
369
 
# File 'lib/norbelys/models/analytics_query_params.rb', line 367

def hash
  [activity, days, dir, domain, exclude_machine, limit, offset, order_by, person, program, receiver, search, sender, since, thread, type, _until].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



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
 
# File 'lib/norbelys/models/analytics_query_params.rb', line 235

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@days.nil? && @days > 365
    invalid_properties.push('invalid value for "days", must be smaller than or equal to 365.')
  end

  if !@days.nil? && @days < 1
    invalid_properties.push('invalid value for "days", must be greater than or equal to 1.')
  end

  if !@limit.nil? && @limit > 1000
    invalid_properties.push('invalid value for "limit", must be smaller than or equal to 1000.')
  end

  if !@limit.nil? && @limit < 1
    invalid_properties.push('invalid value for "limit", must be greater than or equal to 1.')
  end

  if !@offset.nil? && @offset < 0
    invalid_properties.push('invalid value for "offset", must be greater than or equal to 0.')
  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



445
446
447
 
# File 'lib/norbelys/models/analytics_query_params.rb', line 445

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



451
452
453
454
455
456
457
458
459
460
461
462
463
 
# File 'lib/norbelys/models/analytics_query_params.rb', line 451

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



439
440
441
 
# File 'lib/norbelys/models/analytics_query_params.rb', line 439

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



263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/norbelys/models/analytics_query_params.rb', line 263

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@days.nil? && @days > 365
  return false if !@days.nil? && @days < 1
  dir_validator = EnumAttributeValidator.new('String', ["asc", "desc"])
  return false unless dir_validator.valid?(@dir)
  return false if !@limit.nil? && @limit > 1000
  return false if !@limit.nil? && @limit < 1
  return false if !@offset.nil? && @offset < 0
  true
end