Class: Fastly::LineItemData

Inherits:
Object
  • Object
show all
Defined in:
lib/fastly/models/line_item_data.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LineItemData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/fastly/models/line_item_data.rb', line 114

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

Returns the value of attribute amount.



16
17
18
 
# File 'lib/fastly/models/line_item_data.rb', line 16

def amount
  @amount
end

#aria_invoice_id ⇒ Object

Returns the value of attribute aria_invoice_id.



18
19
20
 
# File 'lib/fastly/models/line_item_data.rb', line 18

def aria_invoice_id
  @aria_invoice_id
end

#client_service_id ⇒ Object

Returns the value of attribute client_service_id.



20
21
22
 
# File 'lib/fastly/models/line_item_data.rb', line 20

def client_service_id
  @client_service_id
end

#credit_coupon_code ⇒ Object

Returns the value of attribute credit_coupon_code.



22
23
24
 
# File 'lib/fastly/models/line_item_data.rb', line 22

def credit_coupon_code
  @credit_coupon_code
end

#description ⇒ Object

Returns the value of attribute description.



24
25
26
 
# File 'lib/fastly/models/line_item_data.rb', line 24

def description
  @description
end

#id ⇒ Object

Returns the value of attribute id.



26
27
28
 
# File 'lib/fastly/models/line_item_data.rb', line 26

def id
  @id
end

#line_number ⇒ Object

Returns the value of attribute line_number.



28
29
30
 
# File 'lib/fastly/models/line_item_data.rb', line 28

def line_number
  @line_number
end

#plan_name ⇒ Object

Returns the value of attribute plan_name.



30
31
32
 
# File 'lib/fastly/models/line_item_data.rb', line 30

def plan_name
  @plan_name
end

#plan_no ⇒ Object

Returns the value of attribute plan_no.



32
33
34
 
# File 'lib/fastly/models/line_item_data.rb', line 32

def plan_no
  @plan_no
end

#rate_per_unit ⇒ Object

Returns the value of attribute rate_per_unit.



34
35
36
 
# File 'lib/fastly/models/line_item_data.rb', line 34

def rate_per_unit
  @rate_per_unit
end

#rate_schedule_no ⇒ Object

Returns the value of attribute rate_schedule_no.



36
37
38
 
# File 'lib/fastly/models/line_item_data.rb', line 36

def rate_schedule_no
  @rate_schedule_no
end

#rate_schedule_tier_no ⇒ Object

Returns the value of attribute rate_schedule_tier_no.



38
39
40
 
# File 'lib/fastly/models/line_item_data.rb', line 38

def rate_schedule_tier_no
  @rate_schedule_tier_no
end

#service_name ⇒ Object

Returns the value of attribute service_name.



40
41
42
 
# File 'lib/fastly/models/line_item_data.rb', line 40

def service_name
  @service_name
end

#service_no ⇒ Object

Returns the value of attribute service_no.



42
43
44
 
# File 'lib/fastly/models/line_item_data.rb', line 42

def service_no
  @service_no
end

#units ⇒ Object

Returns the value of attribute units.



44
45
46
 
# File 'lib/fastly/models/line_item_data.rb', line 44

def units
  @units
end

#usage_type_cd ⇒ Object

Returns the value of attribute usage_type_cd.



46
47
48
 
# File 'lib/fastly/models/line_item_data.rb', line 46

def usage_type_cd
  @usage_type_cd
end

#usage_type_no ⇒ Object

Returns the value of attribute usage_type_no.



48
49
50
 
# File 'lib/fastly/models/line_item_data.rb', line 48

def usage_type_no
  @usage_type_no
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



74
75
76
 
# File 'lib/fastly/models/line_item_data.rb', line 74

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/fastly/models/line_item_data.rb', line 51

def self.attribute_map
  {
    :'amount' => :'amount',
    :'aria_invoice_id' => :'aria_invoice_id',
    :'client_service_id' => :'client_service_id',
    :'credit_coupon_code' => :'credit_coupon_code',
    :'description' => :'description',
    :'id' => :'id',
    :'line_number' => :'line_number',
    :'plan_name' => :'plan_name',
    :'plan_no' => :'plan_no',
    :'rate_per_unit' => :'rate_per_unit',
    :'rate_schedule_no' => :'rate_schedule_no',
    :'rate_schedule_tier_no' => :'rate_schedule_tier_no',
    :'service_name' => :'service_name',
    :'service_no' => :'service_no',
    :'units' => :'units',
    :'usage_type_cd' => :'usage_type_cd',
    :'usage_type_no' => :'usage_type_no'
  }
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/fastly/models/line_item_data.rb', line 248

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

.fastly_nullable ⇒ Object

List of attributes with nullable: true



102
103
104
105
106
107
108
109
110
 
# File 'lib/fastly/models/line_item_data.rb', line 102

def self.fastly_nullable
  Set.new([
    :'credit_coupon_code',
    :'rate_schedule_no',
    :'rate_schedule_tier_no',
    :'usage_type_cd',
    :'usage_type_no'
  ])
end

.fastly_types ⇒ Object

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/fastly/models/line_item_data.rb', line 79

def self.fastly_types
  {
    :'amount' => :'Float',
    :'aria_invoice_id' => :'LineItemDataReadOnlyInvoiceId',
    :'client_service_id' => :'String',
    :'credit_coupon_code' => :'String',
    :'description' => :'String',
    :'id' => :'String',
    :'line_number' => :'Integer',
    :'plan_name' => :'String',
    :'plan_no' => :'Float',
    :'rate_per_unit' => :'Float',
    :'rate_schedule_no' => :'Float',
    :'rate_schedule_tier_no' => :'Float',
    :'service_name' => :'String',
    :'service_no' => :'Float',
    :'units' => :'Float',
    :'usage_type_cd' => :'String',
    :'usage_type_no' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      amount == o.amount &&
      aria_invoice_id == o.aria_invoice_id &&
      client_service_id == o.client_service_id &&
      credit_coupon_code == o.credit_coupon_code &&
      description == o.description &&
      id == o.id &&
      line_number == o.line_number &&
      plan_name == o.plan_name &&
      plan_no == o.plan_no &&
      rate_per_unit == o.rate_per_unit &&
      rate_schedule_no == o.rate_schedule_no &&
      rate_schedule_tier_no == o.rate_schedule_tier_no &&
      service_name == o.service_name &&
      service_no == o.service_no &&
      units == o.units &&
      usage_type_cd == o.usage_type_cd &&
      usage_type_no == o.usage_type_no
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
314
315
 
# File 'lib/fastly/models/line_item_data.rb', line 278

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 = Fastly.const_get(type)
    klass.respond_to?(:fastly_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



349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/fastly/models/line_item_data.rb', line 349

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/fastly/models/line_item_data.rb', line 255

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.fastly_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.fastly_nullable.include?(key)
      self.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
      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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


235
236
237
 
# File 'lib/fastly/models/line_item_data.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/fastly/models/line_item_data.rb', line 241

def hash
  [amount, aria_invoice_id, client_service_id, credit_coupon_code, description, id, line_number, plan_name, plan_no, rate_per_unit, rate_schedule_no, rate_schedule_tier_no, service_name, service_no, units, usage_type_cd, usage_type_no].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



198
199
200
201
 
# File 'lib/fastly/models/line_item_data.rb', line 198

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



325
326
327
 
# File 'lib/fastly/models/line_item_data.rb', line 325

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



331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/fastly/models/line_item_data.rb', line 331

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



319
320
321
 
# File 'lib/fastly/models/line_item_data.rb', line 319

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



205
206
207
 
# File 'lib/fastly/models/line_item_data.rb', line 205

def valid?
  true
end