Class: WhiteLabelMachineName::SubscriptionChargeCreate

Inherits:
Object
  • Object
show all
Defined in:
lib/whitelabelmachinename-ruby-sdk/models/subscription_charge_create.rb

Overview

The subscription charge represents a single charge carried out for a particular subscription.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SubscriptionChargeCreate

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



72
73
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
101
102
103
104
105
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_charge_create.rb', line 72

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?(:'externalId')
    self.external_id = attributes[:'externalId']
  end

  if attributes.has_key?(:'failedUrl')
    self.failed_url = attributes[:'failedUrl']
  end

  if attributes.has_key?(:'plannedExecutionDate')
    self.planned_execution_date = attributes[:'plannedExecutionDate']
  end

  if attributes.has_key?(:'processingType')
    self.processing_type = attributes[:'processingType']
  end

  if attributes.has_key?(:'reference')
    self.reference = attributes[:'reference']
  end

  if attributes.has_key?(:'subscription')
    self.subscription = attributes[:'subscription']
  end

  if attributes.has_key?(:'successUrl')
    self.success_url = attributes[:'successUrl']
  end
end

Instance Attribute Details

#external_id ⇒ Object

A client generated nonce which identifies the entity to be created. Subsequent creation requests with the same external ID will not create new entities but return the initially created entity instead.



24
25
26
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_charge_create.rb', line 24

def external_id
  @external_id
end

#failed_url ⇒ Object

The user will be redirected to failed URL when the transaction could not be authorized or completed. In case no failed URL is specified a default failed page will be displayed.



27
28
29
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_charge_create.rb', line 27

def failed_url
  @failed_url
end

#planned_execution_date ⇒ Object

Returns the value of attribute planned_execution_date.



30
31
32
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_charge_create.rb', line 30

def planned_execution_date
  @planned_execution_date
end

#processing_type ⇒ Object

Returns the value of attribute processing_type.



33
34
35
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_charge_create.rb', line 33

def processing_type
  @processing_type
end

#reference ⇒ Object

Returns the value of attribute reference.



36
37
38
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_charge_create.rb', line 36

def reference
  @reference
end

#subscription ⇒ Object

The field subscription indicates the subscription to which the charge belongs to.



39
40
41
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_charge_create.rb', line 39

def subscription
  @subscription
end

#success_url ⇒ Object

The user will be redirected to success URL when the transaction could be authorized or completed. In case no success URL is specified a default success page will be displayed.



42
43
44
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_charge_create.rb', line 42

def success_url
  @success_url
end

Class Method Details

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_charge_create.rb', line 45

def self.attribute_map
  {
    :'external_id' => :'externalId',
    :'failed_url' => :'failedUrl',
    :'planned_execution_date' => :'plannedExecutionDate',
    :'processing_type' => :'processingType',
    :'reference' => :'reference',
    :'subscription' => :'subscription',
    :'success_url' => :'successUrl'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_charge_create.rb', line 58

def self.swagger_types
  {
    :'external_id' => :'String',
    :'failed_url' => :'String',
    :'planned_execution_date' => :'DateTime',
    :'processing_type' => :'SubscriptionChargeProcessingType',
    :'reference' => :'String',
    :'subscription' => :'Integer',
    :'success_url' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_charge_create.rb', line 200

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      external_id == o.external_id &&
      failed_url == o.failed_url &&
      planned_execution_date == o.planned_execution_date &&
      processing_type == o.processing_type &&
      reference == o.reference &&
      subscription == o.subscription &&
      success_url == o.success_url
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_charge_create.rb', line 248

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 = WhiteLabelMachineName.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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_charge_create.rb', line 314

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_charge_create.rb', line 227

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


214
215
216
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_charge_create.rb', line 214

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



220
221
222
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_charge_create.rb', line 220

def hash
  [external_id, failed_url, planned_execution_date, processing_type, reference, subscription, success_url].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_charge_create.rb', line 109

def list_invalid_properties
  invalid_properties = Array.new
  if @external_id.nil?
    invalid_properties.push('invalid value for "external_id", external_id cannot be nil.')
  end

  if !@failed_url.nil? && @failed_url.to_s.length > 500
    invalid_properties.push('invalid value for "failed_url", the character length must be smaller than or equal to 500.')
  end

  if !@failed_url.nil? && @failed_url.to_s.length < 9
    invalid_properties.push('invalid value for "failed_url", the character length must be great than or equal to 9.')
  end

  if @processing_type.nil?
    invalid_properties.push('invalid value for "processing_type", processing_type cannot be nil.')
  end

  if !@reference.nil? && @reference.to_s.length > 100
    invalid_properties.push('invalid value for "reference", the character length must be smaller than or equal to 100.')
  end

  if @subscription.nil?
    invalid_properties.push('invalid value for "subscription", subscription cannot be nil.')
  end

  if !@success_url.nil? && @success_url.to_s.length > 500
    invalid_properties.push('invalid value for "success_url", the character length must be smaller than or equal to 500.')
  end

  if !@success_url.nil? && @success_url.to_s.length < 9
    invalid_properties.push('invalid value for "success_url", the character length must be great than or equal to 9.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



294
295
296
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_charge_create.rb', line 294

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



300
301
302
303
304
305
306
307
308
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_charge_create.rb', line 300

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

Returns:

  • (String) —

    String presentation of the object



288
289
290
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_charge_create.rb', line 288

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_charge_create.rb', line 148

def valid?
  return false if @external_id.nil?
  return false if !@failed_url.nil? && @failed_url.to_s.length > 500
  return false if !@failed_url.nil? && @failed_url.to_s.length < 9
  return false if @processing_type.nil?
  return false if !@reference.nil? && @reference.to_s.length > 100
  return false if @subscription.nil?
  return false if !@success_url.nil? && @success_url.to_s.length > 500
  return false if !@success_url.nil? && @success_url.to_s.length < 9
  true
end