Class: PCPServerSDK::Models::Customer

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

Overview

Object containing the details of a customer.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Customer

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/PCP-server-Ruby-SDK/models/customer.rb', line 79

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account ⇒ Object

Object containing data related to the account the customer has with you.



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

def 
  @account
end

#billing_address ⇒ Object

Returns the value of attribute billing_address.



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

def billing_address
  @billing_address
end

#business_relation ⇒ BusinessRelation

Business relation to the customer. Mandatory for the following payment methods:

  • 3390 - PAYONE Secured Invoice

  • 3391 - PAYONE Secured Installment

  • 3392 - PAYONE Secured Direct Debit

Returns:



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

def business_relation
  @business_relation
end

#company_information ⇒ Object

Returns the value of attribute company_information.



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

def company_information
  @company_information
end

#contact_details ⇒ Object

Returns the value of attribute contact_details.



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

def contact_details
  @contact_details
end

#fiscal_number ⇒ Object

Fiscal registration number of the customer or the tax registration number of the company for a business customer. Please find below specifics per country: * Brazil - Consumer (CPF) with a length of 11 digits * Brazil - Company (CNPJ) with a length of 14 digits * Denmark - Consumer (CPR-nummer or personnummer) with a length of 10 digits * Finland - Consumer (Finnish: henkilötunnus (abbreviated as HETU), Swedish: personbeteckning) with a length of 11 characters * Norway - Consumer (fødselsnummer) with a length of 11 digits * Sweden - Consumer (personnummer) with a length of 10 or 12 digits



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

def fiscal_number
  @fiscal_number
end

#locale ⇒ Object

The locale that the customer should be addressed in (for 3rd parties). Note: Only the language code is supported.



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

def locale
  @locale
end

#merchant_customer_id ⇒ Object

Unique identifier for the customer.



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

def merchant_customer_id
  @merchant_customer_id
end

#personal_information ⇒ Object

Returns the value of attribute personal_information.



31
32
33
 
# File 'lib/PCP-server-Ruby-SDK/models/customer.rb', line 31

def personal_information
  @personal_information
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



184
185
186
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
 
# File 'lib/PCP-server-Ruby-SDK/models/customer.rb', line 184

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



52
53
54
 
# File 'lib/PCP-server-Ruby-SDK/models/customer.rb', line 52

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'company_information' => :'companyInformation',
    :'merchant_customer_id' => :'merchantCustomerId',
    :'billing_address' => :'billingAddress',
    :'contact_details' => :'contactDetails',
    :'fiscal_number' => :'fiscalNumber',
    :'business_relation' => :'businessRelation',
    :'locale' => :'locale',
    :'personal_information' => :'personalInformation',
    :'account' => :'account'
  }
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



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/customer.rb', line 160

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



72
73
74
75
 
# File 'lib/PCP-server-Ruby-SDK/models/customer.rb', line 72

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

.openapi_types ⇒ Object

Attribute type mapping.



57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/PCP-server-Ruby-SDK/models/customer.rb', line 57

def self.openapi_types
  {
    :'company_information' => :'CompanyInformation',
    :'merchant_customer_id' => :'String',
    :'billing_address' => :'Address',
    :'contact_details' => :'ContactDetails',
    :'fiscal_number' => :'String',
    :'business_relation' => :'BusinessRelation',
    :'locale' => :'String',
    :'personal_information' => :'PersonalInformation',
    :'account' => :'CustomerAccount'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/PCP-server-Ruby-SDK/models/customer.rb', line 131

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      company_information == o.company_information &&
      merchant_customer_id == o.merchant_customer_id &&
      billing_address == o.billing_address &&
      contact_details == o.contact_details &&
      fiscal_number == o.fiscal_number &&
      business_relation == o.business_relation &&
      locale == o.locale &&
      personal_information == o.personal_information &&
       == o.
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



255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/PCP-server-Ruby-SDK/models/customer.rb', line 255

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


147
148
149
 
# File 'lib/PCP-server-Ruby-SDK/models/customer.rb', line 147

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



153
154
155
 
# File 'lib/PCP-server-Ruby-SDK/models/customer.rb', line 153

def hash
  [company_information, merchant_customer_id, billing_address, contact_details, fiscal_number, business_relation, locale, personal_information, ].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



231
232
233
 
# File 'lib/PCP-server-Ruby-SDK/models/customer.rb', line 231

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



237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/PCP-server-Ruby-SDK/models/customer.rb', line 237

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



225
226
227
 
# File 'lib/PCP-server-Ruby-SDK/models/customer.rb', line 225

def to_s
  to_hash.to_s
end