Class: ApiReference::SubscriptionTrialInfo

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

Overview

SubscriptionTrialInfo Model.

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(end_date:, additional_properties: nil) ⇒ SubscriptionTrialInfo

Returns a new instance of SubscriptionTrialInfo.



36
37
38
39
40
41
42
 
# File 'lib/api_reference/models/subscription_trial_info.rb', line 36

def initialize(end_date:, additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @end_date = end_date
  @additional_properties = additional_properties
end

Instance Attribute Details

#end_date ⇒ DateTime

TODO: Write general description for this method

Returns:

  • (DateTime) 


15
16
17
 
# File 'lib/api_reference/models/subscription_trial_info.rb', line 15

def end_date
  @end_date
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/api_reference/models/subscription_trial_info.rb', line 45

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  end_date = if hash.key?('end_date')
               (DateTimeHelper.from_rfc3339(hash['end_date']) if hash['end_date'])
             end

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  SubscriptionTrialInfo.new(end_date: end_date,
                            additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



18
19
20
21
22
 
# File 'lib/api_reference/models/subscription_trial_info.rb', line 18

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

.nullables ⇒ Object

An array for nullable fields



30
31
32
33
34
 
# File 'lib/api_reference/models/subscription_trial_info.rb', line 30

def self.nullables
  %w[
    end_date
  ]
end

.optionals ⇒ Object

An array for optional fields



25
26
27
 
# File 'lib/api_reference/models/subscription_trial_info.rb', line 25

def self.optionals
  []
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:



71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/api_reference/models/subscription_trial_info.rb', line 71

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

  return false unless value.instance_of? Hash

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

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



90
91
92
93
94
 
# File 'lib/api_reference/models/subscription_trial_info.rb', line 90

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

#to_custom_end_date ⇒ Object 



65
66
67
 
# File 'lib/api_reference/models/subscription_trial_info.rb', line 65

def to_custom_end_date
  DateTimeHelper.to_rfc3339(end_date)
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



84
85
86
87
 
# File 'lib/api_reference/models/subscription_trial_info.rb', line 84

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