Class: PCPServerSDK::Models::CreateCommerceCaseResponse

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

Overview

The response contains references to the created Commerce case and the Checkout. It also contains the payment response if the flag ‘autoExecuteOrder’ was set to true.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateCommerceCaseResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/PCP-server-Ruby-SDK/models/create_commerce_case_response.rb', line 56

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

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

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

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

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

Instance Attribute Details

#checkout ⇒ Object

Returns the value of attribute checkout.



16
17
18
 
# File 'lib/PCP-server-Ruby-SDK/models/create_commerce_case_response.rb', line 16

def checkout
  @checkout
end

#commerce_case_id ⇒ Object

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



9
10
11
 
# File 'lib/PCP-server-Ruby-SDK/models/create_commerce_case_response.rb', line 9

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.



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

def creation_date_time
  @creation_date_time
end

#customer ⇒ Object

Returns the value of attribute customer.



14
15
16
 
# File 'lib/PCP-server-Ruby-SDK/models/create_commerce_case_response.rb', line 14

def customer
  @customer
end

#merchant_reference ⇒ Object

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



12
13
14
 
# File 'lib/PCP-server-Ruby-SDK/models/create_commerce_case_response.rb', line 12

def merchant_reference
  @merchant_reference
end

Class Method Details

._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



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/PCP-server-Ruby-SDK/models/create_commerce_case_response.rb', line 141

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::Models.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



33
34
35
 
# File 'lib/PCP-server-Ruby-SDK/models/create_commerce_case_response.rb', line 33

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



22
23
24
25
26
27
28
29
30
 
# File 'lib/PCP-server-Ruby-SDK/models/create_commerce_case_response.rb', line 22

def self.attribute_map
  {
    :'commerce_case_id' => :'commerceCaseId',
    :'merchant_reference' => :'merchantReference',
    :'customer' => :'customer',
    :'checkout' => :'checkout',
    :'creation_date_time' => :'creationDateTime'
  }
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



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/PCP-server-Ruby-SDK/models/create_commerce_case_response.rb', line 117

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



49
50
51
52
 
# File 'lib/PCP-server-Ruby-SDK/models/create_commerce_case_response.rb', line 49

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

.openapi_types ⇒ Object

Attribute type mapping.



38
39
40
41
42
43
44
45
46
 
# File 'lib/PCP-server-Ruby-SDK/models/create_commerce_case_response.rb', line 38

def self.openapi_types
  {
    :'commerce_case_id' => :'String',
    :'merchant_reference' => :'String',
    :'customer' => :'Customer',
    :'checkout' => :'CreateCheckoutResponse',
    :'creation_date_time' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



92
93
94
95
96
97
98
99
100
 
# File 'lib/PCP-server-Ruby-SDK/models/create_commerce_case_response.rb', line 92

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      commerce_case_id == o.commerce_case_id &&
      merchant_reference == o.merchant_reference &&
      customer == o.customer &&
      checkout == o.checkout &&
      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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/PCP-server-Ruby-SDK/models/create_commerce_case_response.rb', line 212

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


104
105
106
 
# File 'lib/PCP-server-Ruby-SDK/models/create_commerce_case_response.rb', line 104

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



110
111
112
 
# File 'lib/PCP-server-Ruby-SDK/models/create_commerce_case_response.rb', line 110

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

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



188
189
190
 
# File 'lib/PCP-server-Ruby-SDK/models/create_commerce_case_response.rb', line 188

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



194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/PCP-server-Ruby-SDK/models/create_commerce_case_response.rb', line 194

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

Returns:

  • (String) —

    String presentation of the object



182
183
184
 
# File 'lib/PCP-server-Ruby-SDK/models/create_commerce_case_response.rb', line 182

def to_s
  to_hash.to_s
end