Class: ApiReference::UnitWithProrationConfig1

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/api_reference/models/unit_with_proration_config1.rb

Overview

Configuration for unit_with_proration pricing

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(unit_amount:) ⇒ UnitWithProrationConfig1

Returns a new instance of UnitWithProrationConfig1.



33
34
35
 
# File 'lib/api_reference/models/unit_with_proration_config1.rb', line 33

def initialize(unit_amount:)
  @unit_amount = unit_amount
end

Instance Attribute Details

#unit_amount ⇒ String

Rate per unit of usage

Returns:

  • (String) 


14
15
16
 
# File 'lib/api_reference/models/unit_with_proration_config1.rb', line 14

def unit_amount
  @unit_amount
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



38
39
40
41
42
43
44
45
46
 
# File 'lib/api_reference/models/unit_with_proration_config1.rb', line 38

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  unit_amount = hash.key?('unit_amount') ? hash['unit_amount'] : nil

  # Create object from extracted values.
  UnitWithProrationConfig1.new(unit_amount: unit_amount)
end

.names ⇒ Object

A mapping from model property names to API property names.



17
18
19
20
21
 
# File 'lib/api_reference/models/unit_with_proration_config1.rb', line 17

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['unit_amount'] = 'unit_amount'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



29
30
31
 
# File 'lib/api_reference/models/unit_with_proration_config1.rb', line 29

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



24
25
26
 
# File 'lib/api_reference/models/unit_with_proration_config1.rb', line 24

def self.optionals
  []
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:



50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/api_reference/models/unit_with_proration_config1.rb', line 50

def self.validate(value)
  if value.instance_of? self
    return APIHelper.valid_type?(value.unit_amount,
                                 ->(val) { val.instance_of? String })
  end

  return false unless value.instance_of? Hash

  APIHelper.valid_type?(value['unit_amount'],
                        ->(val) { val.instance_of? String })
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



69
70
71
72
 
# File 'lib/api_reference/models/unit_with_proration_config1.rb', line 69

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} unit_amount: #{@unit_amount.inspect}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



63
64
65
66
 
# File 'lib/api_reference/models/unit_with_proration_config1.rb', line 63

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} unit_amount: #{@unit_amount}>"
end