Class: SendX::ListRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/sendx-ruby-sdk/models/list_request.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ListRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/sendx-ruby-sdk/models/list_request.rb', line 135

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#confirm_from_email ⇒ Object

Email address from which the confirmation email is sent



46
47
48
 
# File 'lib/sendx-ruby-sdk/models/list_request.rb', line 46

def confirm_from_email
  @confirm_from_email
end

#confirm_from_name ⇒ Object

Name displayed as the sender in the confirmation email



43
44
45
 
# File 'lib/sendx-ruby-sdk/models/list_request.rb', line 43

def confirm_from_name
  @confirm_from_name
end

#confirm_mail_message ⇒ Object

Plain text message body of the confirmation email



52
53
54
 
# File 'lib/sendx-ruby-sdk/models/list_request.rb', line 52

def confirm_mail_message
  @confirm_mail_message
end

#confirm_mail_subject ⇒ Object

Subject line of the confirmation email



49
50
51
 
# File 'lib/sendx-ruby-sdk/models/list_request.rb', line 49

def confirm_mail_subject
  @confirm_mail_subject
end

#confirm_sender ⇒ Object

Sender ID for the confirmation email



58
59
60
 
# File 'lib/sendx-ruby-sdk/models/list_request.rb', line 58

def confirm_sender
  @confirm_sender
end

#confirm_success_page ⇒ Object

URL of the success page after confirmation



55
56
57
 
# File 'lib/sendx-ruby-sdk/models/list_request.rb', line 55

def confirm_success_page
  @confirm_success_page
end

#name ⇒ Object

Name of the list



19
20
21
 
# File 'lib/sendx-ruby-sdk/models/list_request.rb', line 19

def name
  @name
end

#send_thank_you_mail ⇒ Object

Indicates if a thank-you email should be sent



25
26
27
 
# File 'lib/sendx-ruby-sdk/models/list_request.rb', line 25

def send_thank_you_mail
  @send_thank_you_mail
end

#thank_you_from_email ⇒ Object

Email address from which the thank-you email is sent



31
32
33
 
# File 'lib/sendx-ruby-sdk/models/list_request.rb', line 31

def thank_you_from_email
  @thank_you_from_email
end

#thank_you_from_name ⇒ Object

Name displayed as the sender in the thank-you email



28
29
30
 
# File 'lib/sendx-ruby-sdk/models/list_request.rb', line 28

def thank_you_from_name
  @thank_you_from_name
end

#thank_you_mail_message ⇒ Object

Plain text message body of the thank-you email



37
38
39
 
# File 'lib/sendx-ruby-sdk/models/list_request.rb', line 37

def thank_you_mail_message
  @thank_you_mail_message
end

#thank_you_mail_subject ⇒ Object

Subject line of the thank-you email



34
35
36
 
# File 'lib/sendx-ruby-sdk/models/list_request.rb', line 34

def thank_you_mail_subject
  @thank_you_mail_subject
end

#thank_you_sender ⇒ Object

Sender ID for the thank-you email



40
41
42
 
# File 'lib/sendx-ruby-sdk/models/list_request.rb', line 40

def thank_you_sender
  @thank_you_sender
end

#type ⇒ Object

Type of the list representing opt-in methods
0: Single opt-in list
1: Double opt-in list



22
23
24
 
# File 'lib/sendx-ruby-sdk/models/list_request.rb', line 22

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



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/sendx-ruby-sdk/models/list_request.rb', line 292

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



103
104
105
 
# File 'lib/sendx-ruby-sdk/models/list_request.rb', line 103

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/sendx-ruby-sdk/models/list_request.rb', line 83

def self.attribute_map
  {
    :'name' => :'name',
    :'type' => :'type',
    :'send_thank_you_mail' => :'sendThankYouMail',
    :'thank_you_from_name' => :'thankYouFromName',
    :'thank_you_from_email' => :'thankYouFromEmail',
    :'thank_you_mail_subject' => :'thankYouMailSubject',
    :'thank_you_mail_message' => :'thankYouMailMessage',
    :'thank_you_sender' => :'thankYouSender',
    :'confirm_from_name' => :'confirmFromName',
    :'confirm_from_email' => :'confirmFromEmail',
    :'confirm_mail_subject' => :'confirmMailSubject',
    :'confirm_mail_message' => :'confirmMailMessage',
    :'confirm_success_page' => :'confirmSuccessPage',
    :'confirm_sender' => :'confirmSender'
  }
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



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/sendx-ruby-sdk/models/list_request.rb', line 268

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



128
129
130
131
 
# File 'lib/sendx-ruby-sdk/models/list_request.rb', line 128

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

.openapi_types ⇒ Object

Attribute type mapping.



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/sendx-ruby-sdk/models/list_request.rb', line 108

def self.openapi_types
  {
    :'name' => :'String',
    :'type' => :'Integer',
    :'send_thank_you_mail' => :'Boolean',
    :'thank_you_from_name' => :'String',
    :'thank_you_from_email' => :'String',
    :'thank_you_mail_subject' => :'String',
    :'thank_you_mail_message' => :'String',
    :'thank_you_sender' => :'String',
    :'confirm_from_name' => :'String',
    :'confirm_from_email' => :'String',
    :'confirm_mail_subject' => :'String',
    :'confirm_mail_message' => :'String',
    :'confirm_success_page' => :'String',
    :'confirm_sender' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/sendx-ruby-sdk/models/list_request.rb', line 234

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      type == o.type &&
      send_thank_you_mail == o.send_thank_you_mail &&
      thank_you_from_name == o.thank_you_from_name &&
      thank_you_from_email == o.thank_you_from_email &&
      thank_you_mail_subject == o.thank_you_mail_subject &&
      thank_you_mail_message == o.thank_you_mail_message &&
      thank_you_sender == o.thank_you_sender &&
      confirm_from_name == o.confirm_from_name &&
      confirm_from_email == o.confirm_from_email &&
      confirm_mail_subject == o.confirm_mail_subject &&
      confirm_mail_message == o.confirm_mail_message &&
      confirm_success_page == o.confirm_success_page &&
      confirm_sender == o.confirm_sender
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



363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/sendx-ruby-sdk/models/list_request.rb', line 363

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


255
256
257
 
# File 'lib/sendx-ruby-sdk/models/list_request.rb', line 255

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



261
262
263
 
# File 'lib/sendx-ruby-sdk/models/list_request.rb', line 261

def hash
  [name, type, send_thank_you_mail, thank_you_from_name, thank_you_from_email, thank_you_mail_subject, thank_you_mail_message, thank_you_sender, confirm_from_name, confirm_from_email, confirm_mail_subject, confirm_mail_message, confirm_success_page, confirm_sender].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



207
208
209
210
211
 
# File 'lib/sendx-ruby-sdk/models/list_request.rb', line 207

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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



339
340
341
 
# File 'lib/sendx-ruby-sdk/models/list_request.rb', line 339

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



345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/sendx-ruby-sdk/models/list_request.rb', line 345

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



333
334
335
 
# File 'lib/sendx-ruby-sdk/models/list_request.rb', line 333

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



215
216
217
218
219
220
 
# File 'lib/sendx-ruby-sdk/models/list_request.rb', line 215

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  type_validator = EnumAttributeValidator.new('Integer', [0, 1])
  return false unless type_validator.valid?(@type)
  true
end