Class: SubskribeSandboxClient::CatalogRelationship

Inherits:
Object
  • Object
show all
Defined in:
lib/subskribe_sandbox/models/catalog_relationship.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CatalogRelationship

Initializes the object

Parameters:

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

    Model attributes in the form of hash



77
78
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
 
# File 'lib/subskribe_sandbox/models/catalog_relationship.rb', line 77

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?(:'relationshipId')
    self.relationship_id = attributes[:'relationshipId']
  end

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

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

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

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

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

Instance Attribute Details

#catalog_relationship_type ⇒ Object

Returns the value of attribute catalog_relationship_type.



23
24
25
 
# File 'lib/subskribe_sandbox/models/catalog_relationship.rb', line 23

def catalog_relationship_type
  @catalog_relationship_type
end

#from_plan_id ⇒ Object

Returns the value of attribute from_plan_id.



21
22
23
 
# File 'lib/subskribe_sandbox/models/catalog_relationship.rb', line 21

def from_plan_id
  @from_plan_id
end

#from_product_id ⇒ Object

Returns the value of attribute from_product_id.



19
20
21
 
# File 'lib/subskribe_sandbox/models/catalog_relationship.rb', line 19

def from_product_id
  @from_product_id
end

#relationship_id ⇒ Object

Returns the value of attribute relationship_id.



17
18
19
 
# File 'lib/subskribe_sandbox/models/catalog_relationship.rb', line 17

def relationship_id
  @relationship_id
end

#to_plan_id ⇒ Object

Returns the value of attribute to_plan_id.



27
28
29
 
# File 'lib/subskribe_sandbox/models/catalog_relationship.rb', line 27

def to_plan_id
  @to_plan_id
end

#to_product_id ⇒ Object

Returns the value of attribute to_product_id.



25
26
27
 
# File 'lib/subskribe_sandbox/models/catalog_relationship.rb', line 25

def to_product_id
  @to_product_id
end

Class Method Details

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
61
 
# File 'lib/subskribe_sandbox/models/catalog_relationship.rb', line 52

def self.attribute_map
  {
    :'relationship_id' => :'relationshipId',
    :'from_product_id' => :'fromProductId',
    :'from_plan_id' => :'fromPlanId',
    :'catalog_relationship_type' => :'catalogRelationshipType',
    :'to_product_id' => :'toProductId',
    :'to_plan_id' => :'toPlanId'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
 
# File 'lib/subskribe_sandbox/models/catalog_relationship.rb', line 64

def self.swagger_types
  {
    :'relationship_id' => :'String',
    :'from_product_id' => :'String',
    :'from_plan_id' => :'String',
    :'catalog_relationship_type' => :'String',
    :'to_product_id' => :'String',
    :'to_plan_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



236
237
238
239
240
241
242
243
244
245
 
# File 'lib/subskribe_sandbox/models/catalog_relationship.rb', line 236

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      relationship_id == o.relationship_id &&
      from_product_id == o.from_product_id &&
      from_plan_id == o.from_plan_id &&
      catalog_relationship_type == o.catalog_relationship_type &&
      to_product_id == o.to_product_id &&
      to_plan_id == o.to_plan_id
end

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



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/subskribe_sandbox/models/catalog_relationship.rb', line 283

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



349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/subskribe_sandbox/models/catalog_relationship.rb', line 349

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



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/subskribe_sandbox/models/catalog_relationship.rb', line 262

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  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


249
250
251
 
# File 'lib/subskribe_sandbox/models/catalog_relationship.rb', line 249

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



255
256
257
 
# File 'lib/subskribe_sandbox/models/catalog_relationship.rb', line 255

def hash
  [relationship_id, from_product_id, from_plan_id, catalog_relationship_type, to_product_id, to_plan_id].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



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/subskribe_sandbox/models/catalog_relationship.rb', line 110

def list_invalid_properties
  invalid_properties = Array.new
  if !@from_product_id.nil? && @from_product_id.to_s.length > 36
    invalid_properties.push('invalid value for "from_product_id", the character length must be smaller than or equal to 36.')
  end

  if !@from_product_id.nil? && @from_product_id.to_s.length < 0
    invalid_properties.push('invalid value for "from_product_id", the character length must be great than or equal to 0.')
  end

  if !@from_plan_id.nil? && @from_plan_id.to_s.length > 36
    invalid_properties.push('invalid value for "from_plan_id", the character length must be smaller than or equal to 36.')
  end

  if !@from_plan_id.nil? && @from_plan_id.to_s.length < 0
    invalid_properties.push('invalid value for "from_plan_id", the character length must be great than or equal to 0.')
  end

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

  if !@to_product_id.nil? && @to_product_id.to_s.length > 36
    invalid_properties.push('invalid value for "to_product_id", the character length must be smaller than or equal to 36.')
  end

  if !@to_product_id.nil? && @to_product_id.to_s.length < 0
    invalid_properties.push('invalid value for "to_product_id", the character length must be great than or equal to 0.')
  end

  if !@to_plan_id.nil? && @to_plan_id.to_s.length > 36
    invalid_properties.push('invalid value for "to_plan_id", the character length must be smaller than or equal to 36.')
  end

  if !@to_plan_id.nil? && @to_plan_id.to_s.length < 0
    invalid_properties.push('invalid value for "to_plan_id", the character length must be great than or equal to 0.')
  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



329
330
331
 
# File 'lib/subskribe_sandbox/models/catalog_relationship.rb', line 329

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



335
336
337
338
339
340
341
342
343
 
# File 'lib/subskribe_sandbox/models/catalog_relationship.rb', line 335

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



323
324
325
 
# File 'lib/subskribe_sandbox/models/catalog_relationship.rb', line 323

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



153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/subskribe_sandbox/models/catalog_relationship.rb', line 153

def valid?
  return false if !@from_product_id.nil? && @from_product_id.to_s.length > 36
  return false if !@from_product_id.nil? && @from_product_id.to_s.length < 0
  return false if !@from_plan_id.nil? && @from_plan_id.to_s.length > 36
  return false if !@from_plan_id.nil? && @from_plan_id.to_s.length < 0
  return false if @catalog_relationship_type.nil?
  catalog_relationship_type_validator = EnumAttributeValidator.new('String', ['IS_PERCENT_OF', 'REQUIRE_ALL_PLANS', 'REQUIRE_ANY_PLANS', 'EXCLUDED_PLANS'])
  return false unless catalog_relationship_type_validator.valid?(@catalog_relationship_type)
  return false if !@to_product_id.nil? && @to_product_id.to_s.length > 36
  return false if !@to_product_id.nil? && @to_product_id.to_s.length < 0
  return false if !@to_plan_id.nil? && @to_plan_id.to_s.length > 36
  return false if !@to_plan_id.nil? && @to_plan_id.to_s.length < 0
  true
end