Class: ProtonApi::CustomerAnalysisRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/proton_api/models/customer_analysis_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CustomerAnalysisRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



75
76
77
78
79
80
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/proton_api/models/customer_analysis_request.rb', line 75

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?(:'currency_code')
    self.currency_code = attributes[:'currency_code']
  end

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

  if attributes.has_key?(:'response_limit')
    self.response_limit = attributes[:'response_limit']
  else
    self.response_limit = 10
  end

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

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

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

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

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

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

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

  if attributes.has_key?(:'only_active_customers')
    self.only_active_customers = attributes[:'only_active_customers']
  else
    self.only_active_customers = false
  end
end

Instance Attribute Details

#benchmark_end_date ⇒ Object

Returns the value of attribute benchmark_end_date.



25
26
27
 
# File 'lib/proton_api/models/customer_analysis_request.rb', line 25

def benchmark_end_date
  @benchmark_end_date
end

#benchmark_start_date ⇒ Object

Returns the value of attribute benchmark_start_date.



35
36
37
 
# File 'lib/proton_api/models/customer_analysis_request.rb', line 35

def benchmark_start_date
  @benchmark_start_date
end

#business_id ⇒ Object

Returns the value of attribute business_id.



33
34
35
 
# File 'lib/proton_api/models/customer_analysis_request.rb', line 33

def business_id
  @business_id
end

#client_id ⇒ Object

Returns the value of attribute client_id.



19
20
21
 
# File 'lib/proton_api/models/customer_analysis_request.rb', line 19

def client_id
  @client_id
end

#currency_code ⇒ Object

Returns the value of attribute currency_code.



17
18
19
 
# File 'lib/proton_api/models/customer_analysis_request.rb', line 17

def currency_code
  @currency_code
end

#currency_conversion ⇒ Object

Returns the value of attribute currency_conversion.



27
28
29
 
# File 'lib/proton_api/models/customer_analysis_request.rb', line 27

def currency_conversion
  @currency_conversion
end

#customer_ids ⇒ Object

Returns the value of attribute customer_ids.



31
32
33
 
# File 'lib/proton_api/models/customer_analysis_request.rb', line 31

def customer_ids
  @customer_ids
end

#end_date ⇒ Object

Returns the value of attribute end_date.



23
24
25
 
# File 'lib/proton_api/models/customer_analysis_request.rb', line 23

def end_date
  @end_date
end

#only_active_customers ⇒ Object

Returns the value of attribute only_active_customers.



37
38
39
 
# File 'lib/proton_api/models/customer_analysis_request.rb', line 37

def only_active_customers
  @only_active_customers
end

#response_limit ⇒ Object

Returns the value of attribute response_limit.



21
22
23
 
# File 'lib/proton_api/models/customer_analysis_request.rb', line 21

def response_limit
  @response_limit
end

#start_date ⇒ Object

Returns the value of attribute start_date.



29
30
31
 
# File 'lib/proton_api/models/customer_analysis_request.rb', line 29

def start_date
  @start_date
end

Class Method Details

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/proton_api/models/customer_analysis_request.rb', line 40

def self.attribute_map
  {
    :'currency_code' => :'currency_code',
    :'client_id' => :'client_id',
    :'response_limit' => :'response_limit',
    :'end_date' => :'end_date',
    :'benchmark_end_date' => :'benchmark_end_date',
    :'currency_conversion' => :'currency_conversion',
    :'start_date' => :'start_date',
    :'customer_ids' => :'customer_ids',
    :'business_id' => :'business_id',
    :'benchmark_start_date' => :'benchmark_start_date',
    :'only_active_customers' => :'only_active_customers'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/proton_api/models/customer_analysis_request.rb', line 57

def self.swagger_types
  {
    :'currency_code' => :'String',
    :'client_id' => :'String',
    :'response_limit' => :'Integer',
    :'end_date' => :'Date',
    :'benchmark_end_date' => :'Date',
    :'currency_conversion' => :'String',
    :'start_date' => :'Date',
    :'customer_ids' => :'Array<String>',
    :'business_id' => :'String',
    :'benchmark_start_date' => :'Date',
    :'only_active_customers' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/proton_api/models/customer_analysis_request.rb', line 162

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      currency_code == o.currency_code &&
      client_id == o.client_id &&
      response_limit == o.response_limit &&
      end_date == o.end_date &&
      benchmark_end_date == o.benchmark_end_date &&
      currency_conversion == o.currency_conversion &&
      start_date == o.start_date &&
      customer_ids == o.customer_ids &&
      business_id == o.business_id &&
      benchmark_start_date == o.benchmark_start_date &&
      only_active_customers == o.only_active_customers
end

#_deserialize(type, value) ⇒ Object

Returns Deserialized data.

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/proton_api/models/customer_analysis_request.rb', line 213

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    value
  when :Date
    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 = ProtonApi.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ 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



277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/proton_api/models/customer_analysis_request.rb', line 277

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



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/proton_api/models/customer_analysis_request.rb', line 193

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


180
181
182
 
# File 'lib/proton_api/models/customer_analysis_request.rb', line 180

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



186
187
188
 
# File 'lib/proton_api/models/customer_analysis_request.rb', line 186

def hash
  [currency_code, client_id, response_limit, end_date, benchmark_end_date, currency_conversion, start_date, customer_ids, business_id, benchmark_start_date, only_active_customers].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



134
135
136
137
138
139
140
141
 
# File 'lib/proton_api/models/customer_analysis_request.rb', line 134

def list_invalid_properties
  invalid_properties = Array.new
  if !@response_limit.nil? && @response_limit < 1
    invalid_properties.push('invalid value for "response_limit", must be greater than or equal to 1.')
  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



258
259
260
 
# File 'lib/proton_api/models/customer_analysis_request.rb', line 258

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



264
265
266
267
268
269
270
271
272
 
# File 'lib/proton_api/models/customer_analysis_request.rb', line 264

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 String presentation of the object.

Returns:

  • (String) —

    String presentation of the object



252
253
254
 
# File 'lib/proton_api/models/customer_analysis_request.rb', line 252

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



145
146
147
148
 
# File 'lib/proton_api/models/customer_analysis_request.rb', line 145

def valid?
  return false if !@response_limit.nil? && @response_limit < 1
  true
end