Class: Bfwd::InvoiceChargeRequest

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

Overview

Request object for generating invoices for a subscription’s every outstanding charge.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InvoiceChargeRequest

Initializes the object



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/bf_ruby2/models/invoice_charge_request.rb', line 74

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

  if attributes.has_key?(:'includeInvoicedChargesOnly')
    self.include_invoiced_charges_only = attributes[:'includeInvoicedChargesOnly']
  else
    self.include_invoiced_charges_only = false
  end

  if attributes.has_key?(:'invoiceState')
    self.invoice_state = attributes[:'invoiceState']
  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/invoice_charge_request.rb', line 19

def created
  @created
end

#include_aggregated ⇒ Object

charges for which invoices will be generated:
<span class=\"label label-default\">true</span> &mdash; Include charges marked with ‘Aggregated’ ‘invoicingType` (i.e. charges that would otherwise be included anyway in the next naturally-occurring invoice)
<span class=\"label label-default\">false</span> &mdash; Exclude charges marked with ’Aggregated’ ‘invoicingType` (i.e. prefer that these charges be included instead on the next naturally-occurring invoice).“,”verbs“:



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

def include_aggregated
  @include_aggregated
end

#include_invoiced_charges_only ⇒ Object

charges for which invoices will be generated:
<span class=\"label label-default\">true</span> &mdash; Include those charges raised with ‘no invoice’ specified (i.e. charges against the subscription) &mdash; as well as charges raised against some specific invoice.
<span class=\"label label-default\">false</span> &mdash; Include only charges raised against some specific invoice.“,”verbs“:



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

def include_invoiced_charges_only
  @include_invoiced_charges_only
end

#invoice_state ⇒ Object

(invoice is raised in its default initial state),"description":"Initial state with which any invoices will be generated.“,”verbs“:



28
29
30
 
# File 'lib/bf_ruby2/models/invoice_charge_request.rb', line 28

def invoice_state
  @invoice_state
end

Class Method Details

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
 
# File 'lib/bf_ruby2/models/invoice_charge_request.rb', line 53

def self.attribute_map
  {
    :'created' => :'created',
    :'include_aggregated' => :'includeAggregated',
    :'include_invoiced_charges_only' => :'includeInvoicedChargesOnly',
    :'invoice_state' => :'invoiceState'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
 
# File 'lib/bf_ruby2/models/invoice_charge_request.rb', line 63

def self.swagger_types
  {
    :'created' => :'DateTime',
    :'include_aggregated' => :'BOOLEAN',
    :'include_invoiced_charges_only' => :'BOOLEAN',
    :'invoice_state' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



129
130
131
132
133
134
135
136
 
# File 'lib/bf_ruby2/models/invoice_charge_request.rb', line 129

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      created == o.created &&
      include_aggregated == o.include_aggregated &&
      include_invoiced_charges_only == o.include_invoiced_charges_only &&
      invoice_state == o.invoice_state
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/bf_ruby2/models/invoice_charge_request.rb', line 174

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



240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/bf_ruby2/models/invoice_charge_request.rb', line 240

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



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/bf_ruby2/models/invoice_charge_request.rb', line 153

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

See Also:

  • `==` method


140
141
142
 
# File 'lib/bf_ruby2/models/invoice_charge_request.rb', line 140

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



146
147
148
 
# File 'lib/bf_ruby2/models/invoice_charge_request.rb', line 146

def hash
  [created, include_aggregated, include_invoiced_charges_only, invoice_state].hash
end

#list_invalid_properties ⇒ Object

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



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

def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



220
221
222
 
# File 'lib/bf_ruby2/models/invoice_charge_request.rb', line 220

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



226
227
228
229
230
231
232
233
234
 
# File 'lib/bf_ruby2/models/invoice_charge_request.rb', line 226

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



214
215
216
 
# File 'lib/bf_ruby2/models/invoice_charge_request.rb', line 214

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



111
112
113
114
115
 
# File 'lib/bf_ruby2/models/invoice_charge_request.rb', line 111

def valid?
  invoice_state_validator = EnumAttributeValidator.new('String', ["Paid", "Unpaid", "Pending", "Voided"])
  return false unless invoice_state_validator.valid?(@invoice_state)
  return true
end