Class: Brevo::MasterDetailsResponsePlanInfo

Inherits:
Object
  • Object
show all
Defined in:
lib/brevo/models/master_details_response_plan_info.rb

Overview

Plan details

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MasterDetailsResponsePlanInfo

Initializes the object

Parameters:

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

    Model attributes in the form of hash



84
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
 
# File 'lib/brevo/models/master_details_response_plan_info.rb', line 84

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'currencyCode')
    self.currency_code = attributes[:'currencyCode']
  end

  if attributes.has_key?(:'nextBillingAt')
    self.next_billing_at = attributes[:'nextBillingAt']
  end

  if attributes.has_key?(:'price')
    self.price = attributes[:'price']
  end

  if attributes.has_key?(:'planPeriod')
    self.plan_period = attributes[:'planPeriod']
  end

  if attributes.has_key?(:'subAccounts')
    self.sub_accounts = attributes[:'subAccounts']
  end

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

Instance Attribute Details

#currency_code ⇒ Object

Plan currency



19
20
21
 
# File 'lib/brevo/models/master_details_response_plan_info.rb', line 19

def currency_code
  @currency_code
end

#features ⇒ Object

List of provided features in the plan



34
35
36
 
# File 'lib/brevo/models/master_details_response_plan_info.rb', line 34

def features
  @features
end

#next_billing_at ⇒ Object

Timestamp of next billing date



22
23
24
 
# File 'lib/brevo/models/master_details_response_plan_info.rb', line 22

def next_billing_at
  @next_billing_at
end

#plan_period ⇒ Object

Plan period type



28
29
30
 
# File 'lib/brevo/models/master_details_response_plan_info.rb', line 28

def plan_period
  @plan_period
end

#price ⇒ Object

Plan amount



25
26
27
 
# File 'lib/brevo/models/master_details_response_plan_info.rb', line 25

def price
  @price
end

#sub_accounts ⇒ Object

Number of sub-accounts



31
32
33
 
# File 'lib/brevo/models/master_details_response_plan_info.rb', line 31

def sub_accounts
  @sub_accounts
end

Class Method Details

.attribute_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
 
# File 'lib/brevo/models/master_details_response_plan_info.rb', line 59

def self.attribute_map
  {
    :'currency_code' => :'currencyCode',
    :'next_billing_at' => :'nextBillingAt',
    :'price' => :'price',
    :'plan_period' => :'planPeriod',
    :'sub_accounts' => :'subAccounts',
    :'features' => :'features'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
79
80
 
# File 'lib/brevo/models/master_details_response_plan_info.rb', line 71

def self.swagger_types
  {
    :'currency_code' => :'String',
    :'next_billing_at' => :'Integer',
    :'price' => :'Float',
    :'plan_period' => :'String',
    :'sub_accounts' => :'Integer',
    :'features' => :'Array<MasterDetailsResponsePlanInfoFeatures>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



144
145
146
147
148
149
150
151
152
153
 
# File 'lib/brevo/models/master_details_response_plan_info.rb', line 144

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      currency_code == o.currency_code &&
      next_billing_at == o.next_billing_at &&
      price == o.price &&
      plan_period == o.plan_period &&
      sub_accounts == o.sub_accounts &&
      features == o.features
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



191
192
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
 
# File 'lib/brevo/models/master_details_response_plan_info.rb', line 191

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
    temp_model = Brevo.const_get(type).new
    temp_model.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



257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/brevo/models/master_details_response_plan_info.rb', line 257

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



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/brevo/models/master_details_response_plan_info.rb', line 170

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_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]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


157
158
159
 
# File 'lib/brevo/models/master_details_response_plan_info.rb', line 157

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



163
164
165
 
# File 'lib/brevo/models/master_details_response_plan_info.rb', line 163

def hash
  [currency_code, next_billing_at, price, plan_period, sub_accounts, features].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



119
120
121
122
 
# File 'lib/brevo/models/master_details_response_plan_info.rb', line 119

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



237
238
239
 
# File 'lib/brevo/models/master_details_response_plan_info.rb', line 237

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



243
244
245
246
247
248
249
250
251
 
# File 'lib/brevo/models/master_details_response_plan_info.rb', line 243

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



231
232
233
 
# File 'lib/brevo/models/master_details_response_plan_info.rb', line 231

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



126
127
128
129
130
 
# File 'lib/brevo/models/master_details_response_plan_info.rb', line 126

def valid?
  plan_period_validator = EnumAttributeValidator.new('String', ['month', 'year'])
  return false unless plan_period_validator.valid?(@plan_period)
  true
end