Class: UltracartClient::EmailCommseqSequenceTestRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EmailCommseqSequenceTestRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
# File 'lib/ultracart_api/models/email_commseq_sequence_test_request.rb', line 103

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#address_1Object

Returns the value of attribute address_1.



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

def address_1
  @address_1
end

#address_2Object

Returns the value of attribute address_2.



20
21
22
# File 'lib/ultracart_api/models/email_commseq_sequence_test_request.rb', line 20

def address_2
  @address_2
end

#cart_idObject

Returns the value of attribute cart_id.



22
23
24
# File 'lib/ultracart_api/models/email_commseq_sequence_test_request.rb', line 22

def cart_id
  @cart_id
end

#cart_item_idsObject

Returns the value of attribute cart_item_ids.



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

def cart_item_ids
  @cart_item_ids
end

#cityObject

Returns the value of attribute city.



26
27
28
# File 'lib/ultracart_api/models/email_commseq_sequence_test_request.rb', line 26

def city
  @city
end

#esp_commseq_uuidObject

Returns the value of attribute esp_commseq_uuid.



28
29
30
# File 'lib/ultracart_api/models/email_commseq_sequence_test_request.rb', line 28

def esp_commseq_uuid
  @esp_commseq_uuid
end

#mail_cardObject

Returns the value of attribute mail_card.



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

def mail_card
  @mail_card
end

#nameObject

Returns the value of attribute name.



32
33
34
# File 'lib/ultracart_api/models/email_commseq_sequence_test_request.rb', line 32

def name
  @name
end

#order_idObject

Returns the value of attribute order_id.



34
35
36
# File 'lib/ultracart_api/models/email_commseq_sequence_test_request.rb', line 34

def order_id
  @order_id
end

#please_reviewObject

Returns the value of attribute please_review.



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

def please_review
  @please_review
end

#postal_codeObject

Returns the value of attribute postal_code.



38
39
40
# File 'lib/ultracart_api/models/email_commseq_sequence_test_request.rb', line 38

def postal_code
  @postal_code
end

#send_to_cellphone_e164Object

Returns the value of attribute send_to_cellphone_e164.



40
41
42
# File 'lib/ultracart_api/models/email_commseq_sequence_test_request.rb', line 40

def send_to_cellphone_e164
  @send_to_cellphone_e164
end

#send_to_emailObject

Returns the value of attribute send_to_email.



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

def send_to_email
  @send_to_email
end

#send_to_logged_in_userObject

Returns the value of attribute send_to_logged_in_user.



44
45
46
# File 'lib/ultracart_api/models/email_commseq_sequence_test_request.rb', line 44

def send_to_logged_in_user
  @send_to_logged_in_user
end

#stateObject

Returns the value of attribute state.



46
47
48
# File 'lib/ultracart_api/models/email_commseq_sequence_test_request.rb', line 46

def state
  @state
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



70
71
72
# File 'lib/ultracart_api/models/email_commseq_sequence_test_request.rb', line 70

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
# File 'lib/ultracart_api/models/email_commseq_sequence_test_request.rb', line 49

def self.attribute_map
  {
    :'address_1' => :'address_1',
    :'address_2' => :'address_2',
    :'cart_id' => :'cart_id',
    :'cart_item_ids' => :'cart_item_ids',
    :'city' => :'city',
    :'esp_commseq_uuid' => :'esp_commseq_uuid',
    :'mail_card' => :'mail_card',
    :'name' => :'name',
    :'order_id' => :'order_id',
    :'please_review' => :'please_review',
    :'postal_code' => :'postal_code',
    :'send_to_cellphone_e164' => :'send_to_cellphone_e164',
    :'send_to_email' => :'send_to_email',
    :'send_to_logged_in_user' => :'send_to_logged_in_user',
    :'state' => :'state'
  }
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



229
230
231
# File 'lib/ultracart_api/models/email_commseq_sequence_test_request.rb', line 229

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

.openapi_nullableObject

List of attributes with nullable: true



96
97
98
99
# File 'lib/ultracart_api/models/email_commseq_sequence_test_request.rb', line 96

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

.openapi_typesObject

Attribute type mapping.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
# File 'lib/ultracart_api/models/email_commseq_sequence_test_request.rb', line 75

def self.openapi_types
  {
    :'address_1' => :'String',
    :'address_2' => :'String',
    :'cart_id' => :'String',
    :'cart_item_ids' => :'Array<String>',
    :'city' => :'String',
    :'esp_commseq_uuid' => :'String',
    :'mail_card' => :'Boolean',
    :'name' => :'String',
    :'order_id' => :'String',
    :'please_review' => :'Boolean',
    :'postal_code' => :'String',
    :'send_to_cellphone_e164' => :'String',
    :'send_to_email' => :'String',
    :'send_to_logged_in_user' => :'Boolean',
    :'state' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
# File 'lib/ultracart_api/models/email_commseq_sequence_test_request.rb', line 194

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      address_1 == o.address_1 &&
      address_2 == o.address_2 &&
      cart_id == o.cart_id &&
      cart_item_ids == o.cart_item_ids &&
      city == o.city &&
      esp_commseq_uuid == o.esp_commseq_uuid &&
      mail_card == o.mail_card &&
      name == o.name &&
      order_id == o.order_id &&
      please_review == o.please_review &&
      postal_code == o.postal_code &&
      send_to_cellphone_e164 == o.send_to_cellphone_e164 &&
      send_to_email == o.send_to_email &&
      send_to_logged_in_user == o.send_to_logged_in_user &&
      state == o.state
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



260
261
262
263
264
265
266
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
292
293
294
295
296
297
# File 'lib/ultracart_api/models/email_commseq_sequence_test_request.rb', line 260

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 = UltracartClient.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



331
332
333
334
335
336
337
338
339
340
341
342
343
# File 'lib/ultracart_api/models/email_commseq_sequence_test_request.rb', line 331

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



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
# File 'lib/ultracart_api/models/email_commseq_sequence_test_request.rb', line 236

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


216
217
218
# File 'lib/ultracart_api/models/email_commseq_sequence_test_request.rb', line 216

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



222
223
224
# File 'lib/ultracart_api/models/email_commseq_sequence_test_request.rb', line 222

def hash
  [address_1, address_2, cart_id, cart_item_ids, city, esp_commseq_uuid, mail_card, name, order_id, please_review, postal_code, send_to_cellphone_e164, send_to_email, send_to_logged_in_user, state].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



181
182
183
184
# File 'lib/ultracart_api/models/email_commseq_sequence_test_request.rb', line 181

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



307
308
309
# File 'lib/ultracart_api/models/email_commseq_sequence_test_request.rb', line 307

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



313
314
315
316
317
318
319
320
321
322
323
324
325
# File 'lib/ultracart_api/models/email_commseq_sequence_test_request.rb', line 313

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



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

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



188
189
190
# File 'lib/ultracart_api/models/email_commseq_sequence_test_request.rb', line 188

def valid?
  true
end