Class: NucleusApi::SecurityExclusion

Inherits:
Object
  • Object
show all
Defined in:
lib/nucleus_api/models/security_exclusion.rb

Overview

SecurityExclusion Object

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SecurityExclusion

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
128
129
130
131
132
133
 
# File 'lib/nucleus_api/models/security_exclusion.rb', line 82

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'account_id')
    self. = attributes[:'account_id']
  end

  if attributes.has_key?(:'client_id')
    self.client_id = attributes[:'client_id']
  end

  if attributes.has_key?(:'create_date')
    self.create_date = attributes[:'create_date']
  end

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'is_restrict_buy')
    self.is_restrict_buy = attributes[:'is_restrict_buy']
  end

  if attributes.has_key?(:'is_restrict_sell')
    self.is_restrict_sell = attributes[:'is_restrict_sell']
  end

  if attributes.has_key?(:'metadata')
    if (value = attributes[:'metadata']).is_a?(Hash)
      self.metadata = value
    end
  end

  if attributes.has_key?(:'portfolio_id')
    self.portfolio_id = attributes[:'portfolio_id']
  end

  if attributes.has_key?(:'secondary_id')
    self.secondary_id = attributes[:'secondary_id']
  end

  if attributes.has_key?(:'security_id')
    self.security_id = attributes[:'security_id']
  end

  if attributes.has_key?(:'update_date')
    self.update_date = attributes[:'update_date']
  end
end

Instance Attribute Details

#account_id ⇒ Object

account id



19
20
21
 
# File 'lib/nucleus_api/models/security_exclusion.rb', line 19

def 
  @account_id
end

#client_id ⇒ Object

Client id



22
23
24
 
# File 'lib/nucleus_api/models/security_exclusion.rb', line 22

def client_id
  @client_id
end

#create_date ⇒ Object

Returns the value of attribute create_date.



24
25
26
 
# File 'lib/nucleus_api/models/security_exclusion.rb', line 24

def create_date
  @create_date
end

#id ⇒ Object

Returns the value of attribute id.



26
27
28
 
# File 'lib/nucleus_api/models/security_exclusion.rb', line 26

def id
  @id
end

#is_restrict_buy ⇒ Object

restrict buy



29
30
31
 
# File 'lib/nucleus_api/models/security_exclusion.rb', line 29

def is_restrict_buy
  @is_restrict_buy
end

#is_restrict_sell ⇒ Object

restrict sell



32
33
34
 
# File 'lib/nucleus_api/models/security_exclusion.rb', line 32

def is_restrict_sell
  @is_restrict_sell
end

#metadata ⇒ Object

Returns the value of attribute metadata.



34
35
36
 
# File 'lib/nucleus_api/models/security_exclusion.rb', line 34

def metadata
  @metadata
end

#portfolio_id ⇒ Object

portfolio id



37
38
39
 
# File 'lib/nucleus_api/models/security_exclusion.rb', line 37

def portfolio_id
  @portfolio_id
end

#secondary_id ⇒ Object

Returns the value of attribute secondary_id.



39
40
41
 
# File 'lib/nucleus_api/models/security_exclusion.rb', line 39

def secondary_id
  @secondary_id
end

#security_id ⇒ Object

Security id



42
43
44
 
# File 'lib/nucleus_api/models/security_exclusion.rb', line 42

def security_id
  @security_id
end

#update_date ⇒ Object

Returns the value of attribute update_date.



44
45
46
 
# File 'lib/nucleus_api/models/security_exclusion.rb', line 44

def update_date
  @update_date
end

Class Method Details

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/nucleus_api/models/security_exclusion.rb', line 47

def self.attribute_map
  {
    :'account_id' => :'account_id',
    :'client_id' => :'client_id',
    :'create_date' => :'create_date',
    :'id' => :'id',
    :'is_restrict_buy' => :'is_restrict_buy',
    :'is_restrict_sell' => :'is_restrict_sell',
    :'metadata' => :'metadata',
    :'portfolio_id' => :'portfolio_id',
    :'secondary_id' => :'secondary_id',
    :'security_id' => :'security_id',
    :'update_date' => :'update_date'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/nucleus_api/models/security_exclusion.rb', line 64

def self.swagger_types
  {
    :'account_id' => :'String',
    :'client_id' => :'String',
    :'create_date' => :'DateTime',
    :'id' => :'String',
    :'is_restrict_buy' => :'BOOLEAN',
    :'is_restrict_sell' => :'BOOLEAN',
    :'metadata' => :'Hash<String, String>',
    :'portfolio_id' => :'String',
    :'secondary_id' => :'String',
    :'security_id' => :'String',
    :'update_date' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/nucleus_api/models/security_exclusion.rb', line 170

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      client_id == o.client_id &&
      create_date == o.create_date &&
      id == o.id &&
      is_restrict_buy == o.is_restrict_buy &&
      is_restrict_sell == o.is_restrict_sell &&
      metadata == o.metadata &&
      portfolio_id == o.portfolio_id &&
      secondary_id == o.secondary_id &&
      security_id == o.security_id &&
      update_date == o.update_date
end

#_deserialize(type, value) ⇒ Object

Returns Deserialized data.

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/nucleus_api/models/security_exclusion.rb', line 220

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    (value)
  when :Date
    (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
    temp_model = NucleusApi.const_get(type).new
    temp_model.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



286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/nucleus_api/models/security_exclusion.rb', line 286

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/nucleus_api/models/security_exclusion.rb', line 201

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


188
189
190
 
# File 'lib/nucleus_api/models/security_exclusion.rb', line 188

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



194
195
196
 
# File 'lib/nucleus_api/models/security_exclusion.rb', line 194

def hash
  [, client_id, create_date, id, is_restrict_buy, is_restrict_sell, metadata, portfolio_id, secondary_id, security_id, update_date].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



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/nucleus_api/models/security_exclusion.rb', line 137

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

  if @is_restrict_buy.nil?
    invalid_properties.push('invalid value for "is_restrict_buy", is_restrict_buy cannot be nil.')
  end

  if @is_restrict_sell.nil?
    invalid_properties.push('invalid value for "is_restrict_sell", is_restrict_sell cannot be nil.')
  end

  if @security_id.nil?
    invalid_properties.push('invalid value for "security_id", security_id cannot be nil.')
  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



267
268
269
 
# File 'lib/nucleus_api/models/security_exclusion.rb', line 267

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



273
274
275
276
277
278
279
280
 
# File 'lib/nucleus_api/models/security_exclusion.rb', line 273

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



261
262
263
 
# File 'lib/nucleus_api/models/security_exclusion.rb', line 261

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



160
161
162
163
164
165
166
 
# File 'lib/nucleus_api/models/security_exclusion.rb', line 160

def valid?
  return false if @client_id.nil?
  return false if @is_restrict_buy.nil?
  return false if @is_restrict_sell.nil?
  return false if @security_id.nil?
  true
end