Class: MailSafePro::JobCreateRequest

Inherits:
ApiModelBase show all
Defined in:
lib/mailsafepro/models/job_create_request.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 = {}) ⇒ JobCreateRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/mailsafepro/models/job_create_request.rb', line 85

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

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

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

  if attributes.key?(:'checksmtp')
    self.checksmtp = attributes[:'checksmtp']
  else
    self.checksmtp = false
  end

  if attributes.key?(:'includerawdns')
    self.includerawdns = attributes[:'includerawdns']
  else
    self.includerawdns = false
  end

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

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

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

Instance Attribute Details

#callback_url ⇒ Object

Returns the value of attribute callback_url.



29
30
31
 
# File 'lib/mailsafepro/models/job_create_request.rb', line 29

def callback_url
  @callback_url
end

#checksmtp ⇒ Object

Returns the value of attribute checksmtp.



25
26
27
 
# File 'lib/mailsafepro/models/job_create_request.rb', line 25

def checksmtp
  @checksmtp
end

#emails ⇒ Object

Returns the value of attribute emails.



21
22
23
 
# File 'lib/mailsafepro/models/job_create_request.rb', line 21

def emails
  @emails
end

#file_token ⇒ Object

Returns the value of attribute file_token.



23
24
25
 
# File 'lib/mailsafepro/models/job_create_request.rb', line 23

def file_token
  @file_token
end

#includerawdns ⇒ Object

Returns the value of attribute includerawdns.



27
28
29
 
# File 'lib/mailsafepro/models/job_create_request.rb', line 27

def includerawdns
  @includerawdns
end

#metadata ⇒ Object

Returns the value of attribute metadata.



33
34
35
 
# File 'lib/mailsafepro/models/job_create_request.rb', line 33

def metadata
  @metadata
end

#sandbox ⇒ Object

Returns the value of attribute sandbox.



31
32
33
 
# File 'lib/mailsafepro/models/job_create_request.rb', line 31

def sandbox
  @sandbox
end

#source ⇒ Object

Origen de los datos



19
20
21
 
# File 'lib/mailsafepro/models/job_create_request.rb', line 19

def source
  @source
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



50
51
52
 
# File 'lib/mailsafepro/models/job_create_request.rb', line 50

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



55
56
57
 
# File 'lib/mailsafepro/models/job_create_request.rb', line 55

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/mailsafepro/models/job_create_request.rb', line 36

def self.attribute_map
  {
    :'source' => :'source',
    :'emails' => :'emails',
    :'file_token' => :'file_token',
    :'checksmtp' => :'checksmtp',
    :'includerawdns' => :'includerawdns',
    :'callback_url' => :'callback_url',
    :'sandbox' => :'sandbox',
    :'metadata' => :'metadata'
  }
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



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/mailsafepro/models/job_create_request.rb', line 213

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



74
75
76
77
78
79
80
81
 
# File 'lib/mailsafepro/models/job_create_request.rb', line 74

def self.openapi_nullable
  Set.new([
    :'emails',
    :'file_token',
    :'callback_url',
    :'metadata'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/mailsafepro/models/job_create_request.rb', line 60

def self.openapi_types
  {
    :'source' => :'String',
    :'emails' => :'Array<String>',
    :'file_token' => :'String',
    :'checksmtp' => :'Boolean',
    :'includerawdns' => :'Boolean',
    :'callback_url' => :'String',
    :'sandbox' => :'Boolean',
    :'metadata' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/mailsafepro/models/job_create_request.rb', line 185

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      source == o.source &&
      emails == o.emails &&
      file_token == o.file_token &&
      checksmtp == o.checksmtp &&
      includerawdns == o.includerawdns &&
      callback_url == o.callback_url &&
      sandbox == o.sandbox &&
      metadata == o.metadata
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


200
201
202
 
# File 'lib/mailsafepro/models/job_create_request.rb', line 200

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



206
207
208
 
# File 'lib/mailsafepro/models/job_create_request.rb', line 206

def hash
  [source, emails, file_token, checksmtp, includerawdns, callback_url, sandbox, metadata].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



144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/mailsafepro/models/job_create_request.rb', line 144

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

  pattern = Regexp.new(/^(list|upload)$/)
  if @source !~ pattern
    invalid_properties.push("invalid value for \"source\", must conform to the pattern #{pattern}.")
  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



235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/mailsafepro/models/job_create_request.rb', line 235

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



161
162
163
164
165
166
 
# File 'lib/mailsafepro/models/job_create_request.rb', line 161

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @source.nil?
  return false if @source !~ Regexp.new(/^(list|upload)$/)
  true
end