Class: Api::Customer

Inherits:
Object
  • Object
show all
Defined in:
lib/jamm/api/models/v1_customer.rb,
lib/jamm/api_patches.rb

Overview

Customer object.

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

Raises:

  • (ArgumentError) 


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
 
# File 'lib/jamm/api/models/v1_customer.rb', line 59

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `Api::Customer` initialize method' unless attributes.is_a?(Hash)

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

    h[k.to_sym] = v
  end

  self.id = attributes[:id] if attributes.key?(:id)

  self.email = attributes[:email] if attributes.key?(:email)

  self.activated = attributes[:activated] if attributes.key?(:activated)

  self.status = attributes[:status] if attributes.key?(:status)

  self.bank_information = attributes[:bank_information] if attributes.key?(:bank_information)

  self.created_at = attributes[:created_at] if attributes.key?(:created_at)

  return unless attributes.key?(:updated_at)

  self.updated_at = attributes[:updated_at]
end

Instance Attribute Details

#activated ⇒ Object

Returns the value of attribute activated.



19
20
21
 
# File 'lib/jamm/api/models/v1_customer.rb', line 19

def activated
  @activated
end

#bank_information ⇒ Object

Returns the value of attribute bank_information.



19
20
21
 
# File 'lib/jamm/api/models/v1_customer.rb', line 19

def bank_information
  @bank_information
end

#created_at ⇒ Object

Returns the value of attribute created_at.



19
20
21
 
# File 'lib/jamm/api/models/v1_customer.rb', line 19

def created_at
  @created_at
end

#email ⇒ Object

Returns the value of attribute email.



19
20
21
 
# File 'lib/jamm/api/models/v1_customer.rb', line 19

def email
  @email
end

#id ⇒ Object

Returns the value of attribute id.



19
20
21
 
# File 'lib/jamm/api/models/v1_customer.rb', line 19

def id
  @id
end

#status ⇒ Object

Returns the value of attribute status.



19
20
21
 
# File 'lib/jamm/api/models/v1_customer.rb', line 19

def status
  @status
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



19
20
21
 
# File 'lib/jamm/api/models/v1_customer.rb', line 19

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



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
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/jamm/api/models/v1_customer.rb', line 153

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



35
36
37
 
# File 'lib/jamm/api/models/v1_customer.rb', line 35

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
31
32
 
# File 'lib/jamm/api/models/v1_customer.rb', line 22

def self.attribute_map
  {
    :id => :id,
    :email => :email,
    :activated => :activated,
    :status => :status,
    :bank_information => :bankInformation,
    :created_at => :createdAt,
    :updated_at => :updatedAt
  }
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



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/jamm/api/models/v1_customer.rb', line 130

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.to_s] = 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
      transformed_hash[key.to_s] = attributes[attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) } if attributes[attribute_map[key]].is_a?(Array)
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash[key.to_s] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



53
54
55
 
# File 'lib/jamm/api/models/v1_customer.rb', line 53

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

.openapi_types ⇒ Object

Attribute type mapping.



40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/jamm/api/models/v1_customer.rb', line 40

def self.openapi_types
  {
    :id => :String,
    :email => :String,
    :activated => :Boolean,
    :status => :Apiv1Status,
    :bank_information => :BankInformation,
    :created_at => :Time,
    :updated_at => :Time
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/jamm/api/models/v1_customer.rb', line 102

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    email == other.email &&
    activated == other.activated &&
    status == other.status &&
    bank_information == other.bank_information &&
    created_at == other.created_at &&
    updated_at == other.updated_at
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



224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/jamm/api/models/v1_customer.rb', line 224

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

#charges(pagination: nil) ⇒ Object

Allow to drill down to list charges. e.g. cus.charges –> []



7
8
9
10
11
12
 
# File 'lib/jamm/api_patches.rb', line 7

def charges(pagination: nil)
  Jamm::Charge.list(
    customer: id,
    pagination: pagination
  )
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


117
118
119
 
# File 'lib/jamm/api/models/v1_customer.rb', line 117

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



123
124
125
 
# File 'lib/jamm/api/models/v1_customer.rb', line 123

def hash
  [id, email, activated, status, bank_information, created_at, updated_at].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



88
89
90
91
 
# File 'lib/jamm/api/models/v1_customer.rb', line 88

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  []
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



200
201
202
 
# File 'lib/jamm/api/models/v1_customer.rb', line 200

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



206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/jamm/api/models/v1_customer.rb', line 206

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = 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



194
195
196
 
# File 'lib/jamm/api/models/v1_customer.rb', line 194

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



95
96
97
98
 
# File 'lib/jamm/api/models/v1_customer.rb', line 95

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end