Class: PCPServerSDK::CommerceCaseResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/PCP-server-Ruby-SDK/models/commerce_case_response.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CommerceCaseResponse

Initializes the object



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
94
95
96
97
98
99
100
 
# File 'lib/PCP-server-Ruby-SDK/models/commerce_case_response.rb', line 66

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `PCPServerSDK::CommerceCaseResponse` 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 `PCPServerSDK::CommerceCaseResponse`. 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
  }

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

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

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

  if attributes.key?(:'checkouts')
    if (value = attributes[:'checkouts']).is_a?(Array)
      self.checkouts = value
    end
  end

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

Instance Attribute Details

#checkouts ⇒ Object

Returns the value of attribute checkouts.



26
27
28
 
# File 'lib/PCP-server-Ruby-SDK/models/commerce_case_response.rb', line 26

def checkouts
  @checkouts
end

#commerce_case_id ⇒ Object

Unique ID reference of the Commerce Case. It can be used to add additional Checkouts to the Commerce Case.



22
23
24
 
# File 'lib/PCP-server-Ruby-SDK/models/commerce_case_response.rb', line 22

def commerce_case_id
  @commerce_case_id
end

#creation_date_time ⇒ Object

Creation date and time of the Checkout in RFC3339 format. It can either be provided in the request or otherwise will be automatically set to the time when the request CreateCommerceCase was received. Response values will always be in UTC time, but when providing this field in the requests, the time offset can have different formats. Accepted formats are: * YYYY-MM-DD’T’HH:mm:ss’Z’ * YYYY-MM-DD’T’HH:mm:ss+XX:XX * YYYY-MM-DD’T’HH:mm:ss-XX:XX * YYYY-MM-DD’T’HH:mm’Z’ * YYYY-MM-DD’T’HH:mm+XX:XX * YYYY-MM-DD’T’HH:mm-XX:XX All other formats may be ignored by the system.



29
30
31
 
# File 'lib/PCP-server-Ruby-SDK/models/commerce_case_response.rb', line 29

def creation_date_time
  @creation_date_time
end

#customer ⇒ Object

Returns the value of attribute customer.



24
25
26
 
# File 'lib/PCP-server-Ruby-SDK/models/commerce_case_response.rb', line 24

def customer
  @customer
end

#merchant_reference ⇒ Object

Unique reference of the Commerce Case that is also returned for reporting and reconciliation purposes.



19
20
21
 
# File 'lib/PCP-server-Ruby-SDK/models/commerce_case_response.rb', line 19

def merchant_reference
  @merchant_reference
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/PCP-server-Ruby-SDK/models/commerce_case_response.rb', line 187

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = PCPServerSDK.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



43
44
45
 
# File 'lib/PCP-server-Ruby-SDK/models/commerce_case_response.rb', line 43

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



32
33
34
35
36
37
38
39
40
 
# File 'lib/PCP-server-Ruby-SDK/models/commerce_case_response.rb', line 32

def self.attribute_map
  {
    :'merchant_reference' => :'merchantReference',
    :'commerce_case_id' => :'commerceCaseId',
    :'customer' => :'customer',
    :'checkouts' => :'checkouts',
    :'creation_date_time' => :'creationDateTime'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/PCP-server-Ruby-SDK/models/commerce_case_response.rb', line 163

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



59
60
61
62
 
# File 'lib/PCP-server-Ruby-SDK/models/commerce_case_response.rb', line 59

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



48
49
50
51
52
53
54
55
56
 
# File 'lib/PCP-server-Ruby-SDK/models/commerce_case_response.rb', line 48

def self.openapi_types
  {
    :'merchant_reference' => :'String',
    :'commerce_case_id' => :'String',
    :'customer' => :'Customer',
    :'checkouts' => :'Array<CheckoutResponse>',
    :'creation_date_time' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



138
139
140
141
142
143
144
145
146
 
# File 'lib/PCP-server-Ruby-SDK/models/commerce_case_response.rb', line 138

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      merchant_reference == o.merchant_reference &&
      commerce_case_id == o.commerce_case_id &&
      customer == o.customer &&
      checkouts == o.checkouts &&
      creation_date_time == o.creation_date_time
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/PCP-server-Ruby-SDK/models/commerce_case_response.rb', line 258

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

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


150
151
152
 
# File 'lib/PCP-server-Ruby-SDK/models/commerce_case_response.rb', line 150

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



156
157
158
 
# File 'lib/PCP-server-Ruby-SDK/models/commerce_case_response.rb', line 156

def hash
  [merchant_reference, commerce_case_id, customer, checkouts, creation_date_time].hash
end

#list_invalid_properties ⇒ Object

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



104
105
106
107
108
109
110
111
112
 
# File 'lib/PCP-server-Ruby-SDK/models/commerce_case_response.rb', line 104

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@merchant_reference.nil? && @merchant_reference.to_s.length > 40
    invalid_properties.push('invalid value for "merchant_reference", the character length must be smaller than or equal to 40.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



234
235
236
 
# File 'lib/PCP-server-Ruby-SDK/models/commerce_case_response.rb', line 234

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/PCP-server-Ruby-SDK/models/commerce_case_response.rb', line 240

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.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



228
229
230
 
# File 'lib/PCP-server-Ruby-SDK/models/commerce_case_response.rb', line 228

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



116
117
118
119
120
 
# File 'lib/PCP-server-Ruby-SDK/models/commerce_case_response.rb', line 116

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@merchant_reference.nil? && @merchant_reference.to_s.length > 40
  true
end