Class: Fastly::Invoice

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Invoice

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/fastly/models/invoice.rb', line 85

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#billing_end_date ⇒ Object

Date and time (in ISO 8601 format) for termination point of a billing cycle, signifying the end of charges for a service or subscription.



29
30
31
 
# File 'lib/fastly/models/invoice.rb', line 29

def billing_end_date
  @billing_end_date
end

#billing_start_date ⇒ Object

Date and time (in ISO 8601 format) for initiation point of a billing cycle, signifying the start of charges for a service or subscription.



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

def billing_start_date
  @billing_start_date
end

#currency_code ⇒ Object

Three-letter code representing a specific currency used for financial transactions.



35
36
37
 
# File 'lib/fastly/models/invoice.rb', line 35

def currency_code
  @currency_code
end

#customer_id ⇒ Object

Customer ID associated with the invoice.



17
18
19
 
# File 'lib/fastly/models/invoice.rb', line 17

def customer_id
  @customer_id
end

#invoice_id ⇒ Object

Numeric string identifying the invoice.



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

def invoice_id
  @invoice_id
end

#invoice_posted_on ⇒ Object

Date and time invoice was posted on, in ISO 8601 format.



23
24
25
 
# File 'lib/fastly/models/invoice.rb', line 23

def invoice_posted_on
  @invoice_posted_on
end

#monthly_transaction_amount ⇒ Object

Total billable amount for invoiced services charged within a single month.



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

def monthly_transaction_amount
  @monthly_transaction_amount
end

#statement_number ⇒ Object

Alphanumeric string identifying the statement number.



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

def statement_number
  @statement_number
end

#transaction_line_items ⇒ Object

Returns the value of attribute transaction_line_items.



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

def transaction_line_items
  @transaction_line_items
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



58
59
60
 
# File 'lib/fastly/models/invoice.rb', line 58

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
54
55
 
# File 'lib/fastly/models/invoice.rb', line 43

def self.attribute_map
  {
    :'customer_id' => :'customer_id',
    :'invoice_id' => :'invoice_id',
    :'invoice_posted_on' => :'invoice_posted_on',
    :'billing_start_date' => :'billing_start_date',
    :'billing_end_date' => :'billing_end_date',
    :'statement_number' => :'statement_number',
    :'currency_code' => :'currency_code',
    :'monthly_transaction_amount' => :'monthly_transaction_amount',
    :'transaction_line_items' => :'transaction_line_items'
  }
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



181
182
183
 
# File 'lib/fastly/models/invoice.rb', line 181

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

.fastly_nullable ⇒ Object

List of attributes with nullable: true



78
79
80
81
 
# File 'lib/fastly/models/invoice.rb', line 78

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

.fastly_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/fastly/models/invoice.rb', line 63

def self.fastly_types
  {
    :'customer_id' => :'String',
    :'invoice_id' => :'String',
    :'invoice_posted_on' => :'Time',
    :'billing_start_date' => :'Time',
    :'billing_end_date' => :'Time',
    :'statement_number' => :'String',
    :'currency_code' => :'String',
    :'monthly_transaction_amount' => :'Float',
    :'transaction_line_items' => :'Array<Invoicelineitems>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/fastly/models/invoice.rb', line 152

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      customer_id == o.customer_id &&
      invoice_id == o.invoice_id &&
      invoice_posted_on == o.invoice_posted_on &&
      billing_start_date == o.billing_start_date &&
      billing_end_date == o.billing_end_date &&
      statement_number == o.statement_number &&
      currency_code == o.currency_code &&
      monthly_transaction_amount == o.monthly_transaction_amount &&
      transaction_line_items == o.transaction_line_items
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



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/fastly/models/invoice.rb', line 211

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



282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/fastly/models/invoice.rb', line 282

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



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/fastly/models/invoice.rb', line 188

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


168
169
170
 
# File 'lib/fastly/models/invoice.rb', line 168

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



174
175
176
 
# File 'lib/fastly/models/invoice.rb', line 174

def hash
  [customer_id, invoice_id, invoice_posted_on, billing_start_date, billing_end_date, statement_number, currency_code, monthly_transaction_amount, transaction_line_items].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



139
140
141
142
 
# File 'lib/fastly/models/invoice.rb', line 139

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



258
259
260
 
# File 'lib/fastly/models/invoice.rb', line 258

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



264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/fastly/models/invoice.rb', line 264

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



252
253
254
 
# File 'lib/fastly/models/invoice.rb', line 252

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



146
147
148
 
# File 'lib/fastly/models/invoice.rb', line 146

def valid?
  true
end