Class: ApiReference::SubscriptionScheduleItem

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

Overview

SubscriptionScheduleItem 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(start_date:, end_date:, created_at:, plan:, additional_properties: nil) ⇒ SubscriptionScheduleItem

Returns a new instance of SubscriptionScheduleItem.



52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/api_reference/models/subscription_schedule_item.rb', line 52

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

  @start_date = start_date
  @end_date = end_date
  @created_at = created_at
  @plan = plan
  @additional_properties = additional_properties
end

Instance Attribute Details

#created_at ⇒ DateTime

TODO: Write general description for this method

Returns:

  • (DateTime) 


23
24
25
 
# File 'lib/api_reference/models/subscription_schedule_item.rb', line 23

def created_at
  @created_at
end

#end_date ⇒ DateTime

TODO: Write general description for this method

Returns:

  • (DateTime) 


19
20
21
 
# File 'lib/api_reference/models/subscription_schedule_item.rb', line 19

def end_date
  @end_date
end

#plan ⇒ PlanMinified

TODO: Write general description for this method

Returns:



27
28
29
 
# File 'lib/api_reference/models/subscription_schedule_item.rb', line 27

def plan
  @plan
end

#start_date ⇒ DateTime

TODO: Write general description for this method

Returns:

  • (DateTime) 


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

def start_date
  @start_date
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/api_reference/models/subscription_schedule_item.rb', line 65

def self.from_hash(hash)
  return nil unless hash

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

  # 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.
  SubscriptionScheduleItem.new(start_date: start_date,
                               end_date: end_date,
                               created_at: created_at,
                               plan: plan,
                               additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



30
31
32
33
34
35
36
37
 
# File 'lib/api_reference/models/subscription_schedule_item.rb', line 30

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

.nullables ⇒ Object

An array for nullable fields



45
46
47
48
49
50
 
# File 'lib/api_reference/models/subscription_schedule_item.rb', line 45

def self.nullables
  %w[
    end_date
    plan
  ]
end

.optionals ⇒ Object

An array for optional fields



40
41
42
 
# File 'lib/api_reference/models/subscription_schedule_item.rb', line 40

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



115
116
117
118
119
120
 
# File 'lib/api_reference/models/subscription_schedule_item.rb', line 115

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

#to_custom_created_at ⇒ Object 



103
104
105
 
# File 'lib/api_reference/models/subscription_schedule_item.rb', line 103

def to_custom_created_at
  DateTimeHelper.to_rfc3339(created_at)
end

#to_custom_end_date ⇒ Object 



99
100
101
 
# File 'lib/api_reference/models/subscription_schedule_item.rb', line 99

def to_custom_end_date
  DateTimeHelper.to_rfc3339(end_date)
end

#to_custom_start_date ⇒ Object 



95
96
97
 
# File 'lib/api_reference/models/subscription_schedule_item.rb', line 95

def to_custom_start_date
  DateTimeHelper.to_rfc3339(start_date)
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



108
109
110
111
112
 
# File 'lib/api_reference/models/subscription_schedule_item.rb', line 108

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