Class: TalonOne::CustomerProfile

Inherits:
ApiModelBase show all
Defined in:
lib/talon_one_sdk/models/customer_profile.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ CustomerProfile

Initializes the object

Parameters:

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

    Model attributes in the form of hash



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
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
 
# File 'lib/talon_one_sdk/models/customer_profile.rb', line 112

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

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

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  else
    self.id = nil
  end

  if attributes.key?(:'created')
    self.created = attributes[:'created']
  else
    self.created = nil
  end

  if attributes.key?(:'integration_id')
    self.integration_id = attributes[:'integration_id']
  else
    self.integration_id = nil
  end

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

  if attributes.key?(:'account_id')
    self. = attributes[:'account_id']
  else
    self. = nil
  end

  if attributes.key?(:'closed_sessions')
    self.closed_sessions = attributes[:'closed_sessions']
  else
    self.closed_sessions = nil
  end

  if attributes.key?(:'total_sales')
    self.total_sales = attributes[:'total_sales']
  else
    self.total_sales = nil
  end

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

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

  if attributes.key?(:'last_activity')
    self.last_activity = attributes[:'last_activity']
  else
    self.last_activity = nil
  end

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

Instance Attribute Details

#account_id ⇒ Object

The ID of the Talon.One account that owns this profile.



31
32
33
 
# File 'lib/talon_one_sdk/models/customer_profile.rb', line 31

def 
  @account_id
end

#attributes ⇒ Object

Arbitrary properties associated with this item.



28
29
30
 
# File 'lib/talon_one_sdk/models/customer_profile.rb', line 28

def attributes
  @attributes
end

#audience_memberships ⇒ Object

The audiences the customer belongs to.



43
44
45
 
# File 'lib/talon_one_sdk/models/customer_profile.rb', line 43

def audience_memberships
  @audience_memberships
end

#closed_sessions ⇒ Object

The total number of closed sessions. Does not include closed sessions that have been cancelled or reopened. See the [docs](docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states).



34
35
36
 
# File 'lib/talon_one_sdk/models/customer_profile.rb', line 34

def closed_sessions
  @closed_sessions
end

#created ⇒ Object

The time this entity was created.



22
23
24
 
# File 'lib/talon_one_sdk/models/customer_profile.rb', line 22

def created
  @created
end

#id ⇒ Object

The internal ID of the customer profile.



19
20
21
 
# File 'lib/talon_one_sdk/models/customer_profile.rb', line 19

def id
  @id
end

#integration_id ⇒ Object

The integration ID set by your integration layer.



25
26
27
 
# File 'lib/talon_one_sdk/models/customer_profile.rb', line 25

def integration_id
  @integration_id
end

#last_activity ⇒ Object

Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the Rule Engine and that are not [dry requests](docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](docs.talon.one/integration-api#tag/Coupons/operation/createCouponReservation) for a customer doesn’t impact this field.



46
47
48
 
# File 'lib/talon_one_sdk/models/customer_profile.rb', line 46

def last_activity
  @last_activity
end

#loyalty_memberships ⇒ Object

**DEPRECATED. Always returns ‘null`.** A list of loyalty programs joined by the customer.



40
41
42
 
# File 'lib/talon_one_sdk/models/customer_profile.rb', line 40

def loyalty_memberships
  @loyalty_memberships
end

#sandbox ⇒ Object

An indicator of whether the customer is part of a sandbox or live Application. See the [docs](docs.talon.one/docs/product/applications/overview#application-environments).



49
50
51
 
# File 'lib/talon_one_sdk/models/customer_profile.rb', line 49

def sandbox
  @sandbox
end

#total_sales ⇒ Object

The total amount of money spent by the customer before discounts are applied. The total sales amount excludes the following: - Cancelled or reopened sessions. - Returned items.



37
38
39
 
# File 'lib/talon_one_sdk/models/customer_profile.rb', line 37

def total_sales
  @total_sales
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



69
70
71
 
# File 'lib/talon_one_sdk/models/customer_profile.rb', line 69

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



74
75
76
 
# File 'lib/talon_one_sdk/models/customer_profile.rb', line 74

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/talon_one_sdk/models/customer_profile.rb', line 52

def self.attribute_map
  {
    :'id' => :'id',
    :'created' => :'created',
    :'integration_id' => :'integrationId',
    :'attributes' => :'attributes',
    :'account_id' => :'accountId',
    :'closed_sessions' => :'closedSessions',
    :'total_sales' => :'totalSales',
    :'loyalty_memberships' => :'loyaltyMemberships',
    :'audience_memberships' => :'audienceMemberships',
    :'last_activity' => :'lastActivity',
    :'sandbox' => :'sandbox'
  }
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



353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/talon_one_sdk/models/customer_profile.rb', line 353

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_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



102
103
104
105
106
107
108
 
# File 'lib/talon_one_sdk/models/customer_profile.rb', line 102

def self.openapi_all_of
  [
  :'CustomerProfileEntity',
  :'IntegrationEntity',
  :'NewCustomerProfile'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



96
97
98
99
 
# File 'lib/talon_one_sdk/models/customer_profile.rb', line 96

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

.openapi_types ⇒ Object

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/talon_one_sdk/models/customer_profile.rb', line 79

def self.openapi_types
  {
    :'id' => :'Integer',
    :'created' => :'Time',
    :'integration_id' => :'String',
    :'attributes' => :'Hash<String, Object>',
    :'account_id' => :'Integer',
    :'closed_sessions' => :'Integer',
    :'total_sales' => :'Float',
    :'loyalty_memberships' => :'Array<LoyaltyMembership>',
    :'audience_memberships' => :'Array<AudienceMembership>',
    :'last_activity' => :'Time',
    :'sandbox' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/talon_one_sdk/models/customer_profile.rb', line 322

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      created == o.created &&
      integration_id == o.integration_id &&
      attributes == o.attributes &&
       == o. &&
      closed_sessions == o.closed_sessions &&
      total_sales == o.total_sales &&
      loyalty_memberships == o.loyalty_memberships &&
      audience_memberships == o.audience_memberships &&
      last_activity == o.last_activity &&
      sandbox == o.sandbox
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


340
341
342
 
# File 'lib/talon_one_sdk/models/customer_profile.rb', line 340

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



346
347
348
 
# File 'lib/talon_one_sdk/models/customer_profile.rb', line 346

def hash
  [id, created, integration_id, attributes, , closed_sessions, total_sales, loyalty_memberships, audience_memberships, last_activity, sandbox].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



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
 
# File 'lib/talon_one_sdk/models/customer_profile.rb', line 193

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

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

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

  if @integration_id.to_s.length > 1000
    invalid_properties.push('invalid value for "integration_id", the character length must be smaller than or equal to 1000.')
  end

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

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

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

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

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/talon_one_sdk/models/customer_profile.rb', line 375

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

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/talon_one_sdk/models/customer_profile.rb', line 233

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @created.nil?
  return false if @integration_id.nil?
  return false if @integration_id.to_s.length > 1000
  return false if @account_id.nil?
  return false if @closed_sessions.nil?
  return false if @total_sales.nil?
  return false if @last_activity.nil?
  true
end