Class: Wallee::SubscriptionSuspensionCreate
- Inherits:
-
Object
- Object
- Wallee::SubscriptionSuspensionCreate
- Defined in:
- lib/wallee-ruby-sdk/models/subscription_suspension_create.rb
Instance Attribute Summary collapse
-
#end_action ⇒ Object
When the suspension reaches the planned end date the end action will be carried out.
-
#note ⇒ Object
The note may contain some internal information for the suspension.
-
#planned_end_date ⇒ Object
The planned end date of the suspension identifies the date on which the suspension will be ended automatically.
-
#subscription ⇒ Object
Returns the value of attribute subscription.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ SubscriptionSuspensionCreate
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ SubscriptionSuspensionCreate
Initializes the object
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
# File 'lib/wallee-ruby-sdk/models/subscription_suspension_create.rb', line 57 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?(:'endAction') self.end_action = attributes[:'endAction'] end if attributes.has_key?(:'note') self.note = attributes[:'note'] end if attributes.has_key?(:'plannedEndDate') self.planned_end_date = attributes[:'plannedEndDate'] end if attributes.has_key?(:'subscription') self.subscription = attributes[:'subscription'] end end |
Instance Attribute Details
#end_action ⇒ Object
When the suspension reaches the planned end date the end action will be carried out. This action is only executed when the suspension is ended automatically based on the end date.
24 25 26 |
# File 'lib/wallee-ruby-sdk/models/subscription_suspension_create.rb', line 24 def end_action @end_action end |
#note ⇒ Object
The note may contain some internal information for the suspension. The note will not be disclosed to the subscriber.
27 28 29 |
# File 'lib/wallee-ruby-sdk/models/subscription_suspension_create.rb', line 27 def note @note end |
#planned_end_date ⇒ Object
The planned end date of the suspension identifies the date on which the suspension will be ended automatically.
30 31 32 |
# File 'lib/wallee-ruby-sdk/models/subscription_suspension_create.rb', line 30 def planned_end_date @planned_end_date end |
#subscription ⇒ Object
Returns the value of attribute subscription.
33 34 35 |
# File 'lib/wallee-ruby-sdk/models/subscription_suspension_create.rb', line 33 def subscription @subscription end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
36 37 38 39 40 41 42 43 |
# File 'lib/wallee-ruby-sdk/models/subscription_suspension_create.rb', line 36 def self.attribute_map { :'end_action' => :'endAction', :'note' => :'note', :'planned_end_date' => :'plannedEndDate', :'subscription' => :'subscription' } end |
.swagger_types ⇒ Object
Attribute type mapping.
46 47 48 49 50 51 52 53 |
# File 'lib/wallee-ruby-sdk/models/subscription_suspension_create.rb', line 46 def self.swagger_types { :'end_action' => :'SubscriptionSuspensionAction', :'note' => :'String', :'planned_end_date' => :'DateTime', :'subscription' => :'Integer' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
125 126 127 128 129 130 131 132 |
# File 'lib/wallee-ruby-sdk/models/subscription_suspension_create.rb', line 125 def ==(o) return true if self.equal?(o) self.class == o.class && end_action == o.end_action && note == o.note && planned_end_date == o.planned_end_date && subscription == o.subscription end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
170 171 172 173 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 |
# File 'lib/wallee-ruby-sdk/models/subscription_suspension_create.rb', line 170 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 = Wallee.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
236 237 238 239 240 241 242 243 244 245 246 247 248 |
# File 'lib/wallee-ruby-sdk/models/subscription_suspension_create.rb', line 236 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
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 |
# File 'lib/wallee-ruby-sdk/models/subscription_suspension_create.rb', line 149 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 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
136 137 138 |
# File 'lib/wallee-ruby-sdk/models/subscription_suspension_create.rb', line 136 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
142 143 144 |
# File 'lib/wallee-ruby-sdk/models/subscription_suspension_create.rb', line 142 def hash [end_action, note, planned_end_date, subscription].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 |
# File 'lib/wallee-ruby-sdk/models/subscription_suspension_create.rb', line 82 def list_invalid_properties invalid_properties = Array.new if @end_action.nil? invalid_properties.push('invalid value for "end_action", end_action cannot be nil.') end if !@note.nil? && @note.to_s.length > 300 invalid_properties.push('invalid value for "note", the character length must be smaller than or equal to 300.') end if @planned_end_date.nil? invalid_properties.push('invalid value for "planned_end_date", planned_end_date cannot be nil.') end if @subscription.nil? invalid_properties.push('invalid value for "subscription", subscription cannot be nil.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
216 217 218 |
# File 'lib/wallee-ruby-sdk/models/subscription_suspension_create.rb', line 216 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
222 223 224 225 226 227 228 229 230 |
# File 'lib/wallee-ruby-sdk/models/subscription_suspension_create.rb', line 222 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
210 211 212 |
# File 'lib/wallee-ruby-sdk/models/subscription_suspension_create.rb', line 210 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
105 106 107 108 109 110 111 |
# File 'lib/wallee-ruby-sdk/models/subscription_suspension_create.rb', line 105 def valid? return false if @end_action.nil? return false if !@note.nil? && @note.to_s.length > 300 return false if @planned_end_date.nil? return false if @subscription.nil? true end |