Class: ConnectWise::ProductRecurring

Inherits:
Object
  • Object
show all
Defined in:
lib/connect_wise/models/product_recurring.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ProductRecurring

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


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
 
# File 'lib/connect_wise/models/product_recurring.rb', line 86

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `ConnectWise::ProductRecurring` initialize method' unless attributes.is_a?(Hash)

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) do |(k, v), h|
    raise ArgumentError, "`#{k}` is not a valid attribute in `ConnectWise::ProductRecurring`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect unless self.class.attribute_map.key?(k.to_sym)

    h[k.to_sym] = v
  end

  self.recurring_revenue = attributes[:recurring_revenue] if attributes.key?(:recurring_revenue)

  self.recurring_cost = attributes[:recurring_cost] if attributes.key?(:recurring_cost)

  self.start_date = attributes[:start_date] if attributes.key?(:start_date)

  self.end_date = attributes[:end_date] if attributes.key?(:end_date)

  self.bill_cycle_id = attributes[:bill_cycle_id] if attributes.key?(:bill_cycle_id)

  self.cycles = attributes[:cycles] if attributes.key?(:cycles)

  return unless attributes.key?(:cycle_type)

  self.cycle_type = attributes[:cycle_type]
end

Instance Attribute Details

#bill_cycle_id ⇒ Object

Returns the value of attribute bill_cycle_id.



16
17
18
 
# File 'lib/connect_wise/models/product_recurring.rb', line 16

def bill_cycle_id
  @bill_cycle_id
end

#cycle_type ⇒ Object

Returns the value of attribute cycle_type.



16
17
18
 
# File 'lib/connect_wise/models/product_recurring.rb', line 16

def cycle_type
  @cycle_type
end

#cycles ⇒ Object

Returns the value of attribute cycles.



16
17
18
 
# File 'lib/connect_wise/models/product_recurring.rb', line 16

def cycles
  @cycles
end

#end_date ⇒ Object

The Recurring End Date is calculated based on the start date, number of cycles, and cycle type.



19
20
21
 
# File 'lib/connect_wise/models/product_recurring.rb', line 19

def end_date
  @end_date
end

#recurring_cost ⇒ Object

Returns the value of attribute recurring_cost.



16
17
18
 
# File 'lib/connect_wise/models/product_recurring.rb', line 16

def recurring_cost
  @recurring_cost
end

#recurring_revenue ⇒ Object

Returns the value of attribute recurring_revenue.



16
17
18
 
# File 'lib/connect_wise/models/product_recurring.rb', line 16

def recurring_revenue
  @recurring_revenue
end

#start_date ⇒ Object

Returns the value of attribute start_date.



16
17
18
 
# File 'lib/connect_wise/models/product_recurring.rb', line 16

def start_date
  @start_date
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



56
57
58
 
# File 'lib/connect_wise/models/product_recurring.rb', line 56

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/connect_wise/models/product_recurring.rb', line 43

def self.attribute_map
  {
    recurring_revenue: :recurringRevenue,
    recurring_cost: :recurringCost,
    start_date: :startDate,
    end_date: :endDate,
    bill_cycle_id: :billCycleId,
    cycles: :cycles,
    cycle_type: :cycleType
  }
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



167
168
169
 
# File 'lib/connect_wise/models/product_recurring.rb', line 167

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



74
75
76
77
78
79
80
81
82
 
# File 'lib/connect_wise/models/product_recurring.rb', line 74

def self.openapi_nullable
  Set.new(%i[
            recurring_revenue
            recurring_cost
            bill_cycle_id
            cycles
            cycle_type
          ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    recurring_revenue: :Float,
    recurring_cost: :Float,
    start_date: :String,
    end_date: :String,
    bill_cycle_id: :Integer,
    cycles: :Integer,
    cycle_type: :String
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/connect_wise/models/product_recurring.rb', line 139

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    recurring_revenue == other.recurring_revenue &&
    recurring_cost == other.recurring_cost &&
    start_date == other.start_date &&
    end_date == other.end_date &&
    bill_cycle_id == other.bill_cycle_id &&
    cycles == other.cycles &&
    cycle_type == other.cycle_type
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



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
228
229
230
231
232
233
234
 
# File 'lib/connect_wise/models/product_recurring.rb', line 197

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



268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/connect_wise/models/product_recurring.rb', line 268

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



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/connect_wise/models/product_recurring.rb', line 174

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)
      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
      send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) }) if attributes[self.class.attribute_map[key]].is_a?(Array)
    elsif !attributes[self.class.attribute_map[key]].nil?
      send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


154
155
156
 
# File 'lib/connect_wise/models/product_recurring.rb', line 154

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



160
161
162
 
# File 'lib/connect_wise/models/product_recurring.rb', line 160

def hash
  [recurring_revenue, recurring_cost, start_date, end_date, bill_cycle_id, cycles, cycle_type].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



115
116
117
 
# File 'lib/connect_wise/models/product_recurring.rb', line 115

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



244
245
246
 
# File 'lib/connect_wise/models/product_recurring.rb', line 244

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



250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/connect_wise/models/product_recurring.rb', line 250

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = 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



238
239
240
 
# File 'lib/connect_wise/models/product_recurring.rb', line 238

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



121
122
123
124
125
126
 
# File 'lib/connect_wise/models/product_recurring.rb', line 121

def valid?
  cycle_type_validator = EnumAttributeValidator.new('String', %w[ContractYear CalendarYear])
  return false unless cycle_type_validator.valid?(@cycle_type)

  true
end