Class: SematextCloud::SubscriptionDto

Inherits:
Object
  • Object
show all
Defined in:
lib/SematextCloud/models/subscription_dto.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SubscriptionDto

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/SematextCloud/models/subscription_dto.rb', line 110

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#additional_params ⇒ Object

Returns the value of attribute additional_params.



16
17
18
 
# File 'lib/SematextCloud/models/subscription_dto.rb', line 16

def additional_params
  @additional_params
end

#addresses ⇒ Object

Returns the value of attribute addresses.



18
19
20
 
# File 'lib/SematextCloud/models/subscription_dto.rb', line 18

def addresses
  @addresses
end

#enable ⇒ Object

Returns the value of attribute enable.



20
21
22
 
# File 'lib/SematextCloud/models/subscription_dto.rb', line 20

def enable
  @enable
end

#filters ⇒ Object

Returns the value of attribute filters.



22
23
24
 
# File 'lib/SematextCloud/models/subscription_dto.rb', line 22

def filters
  @filters
end

#frequency ⇒ Object

Returns the value of attribute frequency.



24
25
26
 
# File 'lib/SematextCloud/models/subscription_dto.rb', line 24

def frequency
  @frequency
end

#id ⇒ Object

Returns the value of attribute id.



26
27
28
 
# File 'lib/SematextCloud/models/subscription_dto.rb', line 26

def id
  @id
end

#report_name ⇒ Object

Returns the value of attribute report_name.



28
29
30
 
# File 'lib/SematextCloud/models/subscription_dto.rb', line 28

def report_name
  @report_name
end

#send_time ⇒ Object

Returns the value of attribute send_time.



30
31
32
 
# File 'lib/SematextCloud/models/subscription_dto.rb', line 30

def send_time
  @send_time
end

#subject ⇒ Object

Returns the value of attribute subject.



32
33
34
 
# File 'lib/SematextCloud/models/subscription_dto.rb', line 32

def subject
  @subject
end

#system_id ⇒ Object

Returns the value of attribute system_id.



34
35
36
 
# File 'lib/SematextCloud/models/subscription_dto.rb', line 34

def system_id
  @system_id
end

#text ⇒ Object

Returns the value of attribute text.



36
37
38
 
# File 'lib/SematextCloud/models/subscription_dto.rb', line 36

def text
  @text
end

#time_range ⇒ Object

Returns the value of attribute time_range.



38
39
40
 
# File 'lib/SematextCloud/models/subscription_dto.rb', line 38

def time_range
  @time_range
end

#user_permissions ⇒ Object

Returns the value of attribute user_permissions.



40
41
42
 
# File 'lib/SematextCloud/models/subscription_dto.rb', line 40

def user_permissions
  @user_permissions
end

Class Method Details

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/SematextCloud/models/subscription_dto.rb', line 65

def self.attribute_map
  {
    :'additional_params' => :'additionalParams',
    :'addresses' => :'addresses',
    :'enable' => :'enable',
    :'filters' => :'filters',
    :'frequency' => :'frequency',
    :'id' => :'id',
    :'report_name' => :'reportName',
    :'send_time' => :'sendTime',
    :'subject' => :'subject',
    :'system_id' => :'systemId',
    :'text' => :'text',
    :'time_range' => :'timeRange',
    :'user_permissions' => :'userPermissions'
  }
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



248
249
250
 
# File 'lib/SematextCloud/models/subscription_dto.rb', line 248

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



103
104
105
106
 
# File 'lib/SematextCloud/models/subscription_dto.rb', line 103

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

.openapi_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/SematextCloud/models/subscription_dto.rb', line 84

def self.openapi_types
  {
    :'additional_params' => :'Object',
    :'addresses' => :'Object',
    :'enable' => :'Object',
    :'filters' => :'Object',
    :'frequency' => :'Object',
    :'id' => :'Object',
    :'report_name' => :'Object',
    :'send_time' => :'Object',
    :'subject' => :'Object',
    :'system_id' => :'Object',
    :'text' => :'Object',
    :'time_range' => :'Object',
    :'user_permissions' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      additional_params == o.additional_params &&
      addresses == o.addresses &&
      enable == o.enable &&
      filters == o.filters &&
      frequency == o.frequency &&
      id == o.id &&
      report_name == o.report_name &&
      send_time == o.send_time &&
      subject == o.subject &&
      system_id == o.system_id &&
      text == o.text &&
      time_range == o.time_range &&
      user_permissions == o.user_permissions
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



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/SematextCloud/models/subscription_dto.rb', line 278

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    SematextCloud.const_get(type).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



347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/SematextCloud/models/subscription_dto.rb', line 347

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



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/SematextCloud/models/subscription_dto.rb', line 255

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_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]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


235
236
237
 
# File 'lib/SematextCloud/models/subscription_dto.rb', line 235

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



241
242
243
 
# File 'lib/SematextCloud/models/subscription_dto.rb', line 241

def hash
  [additional_params, addresses, enable, filters, frequency, id, report_name, send_time, subject, system_id, text, time_range, user_permissions].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



178
179
180
181
 
# File 'lib/SematextCloud/models/subscription_dto.rb', line 178

def list_invalid_properties
  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



323
324
325
 
# File 'lib/SematextCloud/models/subscription_dto.rb', line 323

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



329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/SematextCloud/models/subscription_dto.rb', line 329

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



317
318
319
 
# File 'lib/SematextCloud/models/subscription_dto.rb', line 317

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



185
186
187
188
189
190
191
 
# File 'lib/SematextCloud/models/subscription_dto.rb', line 185

def valid?
  frequency_validator = EnumAttributeValidator.new('Object', ['EVERY_FIVE_MINUTES', 'DAILY', 'WEEKLY', 'MONTHLY', 'QUARTERLY'])
  return false unless frequency_validator.valid?(@frequency)
  time_range_validator = EnumAttributeValidator.new('Object', ['ONE_DAY', 'ONE_WEEK', 'ONE_MONTH', 'TWO_MONTH', 'SIX_MONTH', 'ONE_YEAR'])
  return false unless time_range_validator.valid?(@time_range)
  true
end