Class: OpenapiClient::ReferencedOrderPaymentSchedulesRequest

Inherits:
PaymentSchedulesRequest show all
Defined in:
lib/openapi_client/models/referenced_order_payment_schedules_request.rb

Overview

Request to create a new payment schedule using a referenced order ID.

Instance Attribute Summary collapse

Attributes inherited from PaymentSchedulesRequest

#billing, #client_locale, #comments, #dynamic_merchant_name, #frequency, #invoice_number, #maximum_failures, #number_of_payments, #order_id, #purchase_order_number, #request_type, #shipping, #start_date, #store_id, #transaction_amount, #transaction_origin

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from PaymentSchedulesRequest

openapi_discriminator_name

Constructor Details

#initialize(attributes = {}) ⇒ ReferencedOrderPaymentSchedulesRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::ReferencedOrderPaymentSchedulesRequest` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::ReferencedOrderPaymentSchedulesRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  # call parent's initialize
  super(attributes)

  if attributes.key?(:'referenced_order_id')
    self.referenced_order_id = attributes[:'referenced_order_id']
  end
end

Instance Attribute Details

#referenced_order_id ⇒ Object

Order ID used to create recurring payment from existing transaction.



19
20
21
 
# File 'lib/openapi_client/models/referenced_order_payment_schedules_request.rb', line 19

def referenced_order_id
  @referenced_order_id
end

Class Method Details

.attribute_map ⇒ Object

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



22
23
24
25
26
 
# File 'lib/openapi_client/models/referenced_order_payment_schedules_request.rb', line 22

def self.attribute_map
  {
    :'referenced_order_id' => :'referencedOrderId'
  }
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



128
129
130
 
# File 'lib/openapi_client/models/referenced_order_payment_schedules_request.rb', line 128

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



36
37
38
39
40
41
 
# File 'lib/openapi_client/models/referenced_order_payment_schedules_request.rb', line 36

def self.openapi_all_of
  [
  :'PaymentSchedulesRequest',
  :'ReferencedOrderPaymentSchedulesRequestAllOf'
  ]
end

.openapi_types ⇒ Object

Attribute type mapping.



29
30
31
32
33
 
# File 'lib/openapi_client/models/referenced_order_payment_schedules_request.rb', line 29

def self.openapi_types
  {
    :'referenced_order_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



107
108
109
110
111
 
# File 'lib/openapi_client/models/referenced_order_payment_schedules_request.rb', line 107

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      referenced_order_id == o.referenced_order_id && super(o)
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



157
158
159
160
161
162
163
164
165
166
167
168
169
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
 
# File 'lib/openapi_client/models/referenced_order_payment_schedules_request.rb', line 157

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
    klass = OpenapiClient.const_get(type)
    if klass.respond_to?(:openapi_discriminator_name)
      klass = OpenapiClient.const_get(value[klass.attribute_map[klass.openapi_discriminator_name]])
    end
 
    klass.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



231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/openapi_client/models/referenced_order_payment_schedules_request.rb', line 231

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, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/openapi_client/models/referenced_order_payment_schedules_request.rb', line 135

def build_from_hash(attributes, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types)
  return nil unless attributes.is_a?(Hash)
  super(attributes, self.class.superclass.attribute_map, self.class.superclass.openapi_types)
  openapi_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[attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[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


115
116
117
 
# File 'lib/openapi_client/models/referenced_order_payment_schedules_request.rb', line 115

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



121
122
123
 
# File 'lib/openapi_client/models/referenced_order_payment_schedules_request.rb', line 121

def hash
  [referenced_order_id].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



68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/openapi_client/models/referenced_order_payment_schedules_request.rb', line 68

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

  pattern = Regexp.new(/^(?!\s*$).+/)
  if @referenced_order_id !~ pattern
    invalid_properties.push("invalid value for \"referenced_order_id\", must conform to the pattern #{pattern}.")
  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



207
208
209
 
# File 'lib/openapi_client/models/referenced_order_payment_schedules_request.rb', line 207

def to_body
  to_hash
end

#to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([])) ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/openapi_client/models/referenced_order_payment_schedules_request.rb', line 213

def to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([]))
  hash = super(self.class.superclass.attribute_map, openapi_nullable)
  attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end
    
    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



201
202
203
 
# File 'lib/openapi_client/models/referenced_order_payment_schedules_request.rb', line 201

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



84
85
86
87
88
 
# File 'lib/openapi_client/models/referenced_order_payment_schedules_request.rb', line 84

def valid?
  return false if @referenced_order_id.nil?
  return false if @referenced_order_id !~ Regexp.new(/^(?!\s*$).+/)
  true && super
end