Class: Bfwd::CreateAggregatingComponentRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/bf_ruby2/models/create_aggregating_component_request.rb

Overview

Entity for requesting that an ‘aggregating component’ (i.e. a component which should be re-priced upon invoice aggregation) be created.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateAggregatingComponentRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/bf_ruby2/models/create_aggregating_component_request.rb', line 48

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?(:'created')
    self.created = attributes[:'created']
  end

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

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

end

Instance Attribute Details

#created ⇒ Object

{ "description" : "The UTC DateTime when the object was created.", "verbs":[] }



19
20
21
 
# File 'lib/bf_ruby2/models/create_aggregating_component_request.rb', line 19

def created
  @created
end

#organization_id ⇒ Object

using your authentication credentials)","description":"ID of the BillForward Organization within which the requested pricing component should be created. If omitted: this will be auto-populated using your authentication credentials.“,”verbs“:



25
26
27
 
# File 'lib/bf_ruby2/models/create_aggregating_component_request.rb', line 25

def organization_id
  @organization_id
end

#pricing_component ⇒ Object

of the pricing component upon which to aggregate. The subscriber to the aggregating rate plan (which contains the AggregatingComponent specified here), will consult its children at the end of each billing period, and collect from those children all charges whose pricing component matches the ID of the component identified here. Those charges’ quantities will be counted, and used when calculating the price of consuming this AggregatingComponent. The aggregating subscription then raises a discount charge — to account for the more favourable price tiering that emerges when aggregating.“,”verbs“:



22
23
24
 
# File 'lib/bf_ruby2/models/create_aggregating_component_request.rb', line 22

def pricing_component
  @pricing_component
end

Class Method Details

.attribute_map ⇒ Object

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



29
30
31
32
33
34
35
 
# File 'lib/bf_ruby2/models/create_aggregating_component_request.rb', line 29

def self.attribute_map
  {
    :'created' => :'created',
    :'pricing_component' => :'pricingComponent',
    :'organization_id' => :'organizationID'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



38
39
40
41
42
43
44
 
# File 'lib/bf_ruby2/models/create_aggregating_component_request.rb', line 38

def self.swagger_types
  {
    :'created' => :'DateTime',
    :'pricing_component' => :'String',
    :'organization_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



88
89
90
91
92
93
94
 
# File 'lib/bf_ruby2/models/create_aggregating_component_request.rb', line 88

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      created == o.created &&
      pricing_component == o.pricing_component &&
      organization_id == o.organization_id
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



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
 
# File 'lib/bf_ruby2/models/create_aggregating_component_request.rb', line 132

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



198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/bf_ruby2/models/create_aggregating_component_request.rb', line 198

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



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/bf_ruby2/models/create_aggregating_component_request.rb', line 111

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


98
99
100
 
# File 'lib/bf_ruby2/models/create_aggregating_component_request.rb', line 98

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



104
105
106
 
# File 'lib/bf_ruby2/models/create_aggregating_component_request.rb', line 104

def hash
  [created, pricing_component, organization_id].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



70
71
72
73
74
75
76
77
 
# File 'lib/bf_ruby2/models/create_aggregating_component_request.rb', line 70

def list_invalid_properties
  invalid_properties = Array.new
  if @pricing_component.nil?
    invalid_properties.push("invalid value for 'pricing_component', pricing_component cannot be nil.")
  end

  return 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



178
179
180
 
# File 'lib/bf_ruby2/models/create_aggregating_component_request.rb', line 178

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



184
185
186
187
188
189
190
191
192
 
# File 'lib/bf_ruby2/models/create_aggregating_component_request.rb', line 184

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



172
173
174
 
# File 'lib/bf_ruby2/models/create_aggregating_component_request.rb', line 172

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



81
82
83
84
 
# File 'lib/bf_ruby2/models/create_aggregating_component_request.rb', line 81

def valid?
  return false if @pricing_component.nil?
  return true
end