Class: SubskribeSandboxClient::PlanJson

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PlanJson

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
134
135
136
137
138
139
140
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
 
# File 'lib/subskribe_sandbox/models/plan_json.rb', line 105

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

  if attributes.has_key?(:'entityIds')
    if (value = attributes[:'entityIds']).is_a?(Array)
      self.entity_ids = value
    end
  end

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'templateIds')
    if (value = attributes[:'templateIds']).is_a?(Array)
      self.template_ids = value
    end
  end

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

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

Instance Attribute Details

#charges ⇒ Object

Returns the value of attribute charges.



31
32
33
 
# File 'lib/subskribe_sandbox/models/plan_json.rb', line 31

def charges
  @charges
end

#currency ⇒ Object

Returns the value of attribute currency.



33
34
35
 
# File 'lib/subskribe_sandbox/models/plan_json.rb', line 33

def currency
  @currency
end

#custom_fields ⇒ Object

Returns the value of attribute custom_fields.



39
40
41
 
# File 'lib/subskribe_sandbox/models/plan_json.rb', line 39

def custom_fields
  @custom_fields
end

#description ⇒ Object

Returns the value of attribute description.



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

def description
  @description
end

#display_name ⇒ Object

Returns the value of attribute display_name.



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

def display_name
  @display_name
end

#entity_ids ⇒ Object

Returns the value of attribute entity_ids.



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

def entity_ids
  @entity_ids
end

#external_id ⇒ Object

Returns the value of attribute external_id.



35
36
37
 
# File 'lib/subskribe_sandbox/models/plan_json.rb', line 35

def external_id
  @external_id
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#product_id ⇒ Object

Returns the value of attribute product_id.



29
30
31
 
# File 'lib/subskribe_sandbox/models/plan_json.rb', line 29

def product_id
  @product_id
end

#status ⇒ Object

Returns the value of attribute status.



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

def status
  @status
end

#template_ids ⇒ Object

Returns the value of attribute template_ids.



37
38
39
 
# File 'lib/subskribe_sandbox/models/plan_json.rb', line 37

def template_ids
  @template_ids
end

#updated_on ⇒ Object

Returns the value of attribute updated_on.



41
42
43
 
# File 'lib/subskribe_sandbox/models/plan_json.rb', line 41

def updated_on
  @updated_on
end

Class Method Details

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/subskribe_sandbox/models/plan_json.rb', line 66

def self.attribute_map
  {
    :'id' => :'id',
    :'entity_ids' => :'entityIds',
    :'name' => :'name',
    :'display_name' => :'displayName',
    :'description' => :'description',
    :'status' => :'status',
    :'product_id' => :'productId',
    :'charges' => :'charges',
    :'currency' => :'currency',
    :'external_id' => :'externalId',
    :'template_ids' => :'templateIds',
    :'custom_fields' => :'customFields',
    :'updated_on' => :'updatedOn'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/subskribe_sandbox/models/plan_json.rb', line 85

def self.swagger_types
  {
    :'id' => :'String',
    :'entity_ids' => :'Array<String>',
    :'name' => :'String',
    :'display_name' => :'String',
    :'description' => :'String',
    :'status' => :'String',
    :'product_id' => :'String',
    :'charges' => :'Array<ChargeJson>',
    :'currency' => :'String',
    :'external_id' => :'String',
    :'template_ids' => :'Array<String>',
    :'custom_fields' => :'Hash<String, CustomFieldValue>',
    :'updated_on' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/subskribe_sandbox/models/plan_json.rb', line 204

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      entity_ids == o.entity_ids &&
      name == o.name &&
      display_name == o.display_name &&
      description == o.description &&
      status == o.status &&
      product_id == o.product_id &&
      charges == o.charges &&
      currency == o.currency &&
      external_id == o.external_id &&
      template_ids == o.template_ids &&
      custom_fields == o.custom_fields &&
      updated_on == o.updated_on
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



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/subskribe_sandbox/models/plan_json.rb', line 258

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



324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/subskribe_sandbox/models/plan_json.rb', line 324

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



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/subskribe_sandbox/models/plan_json.rb', line 237

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


224
225
226
 
# File 'lib/subskribe_sandbox/models/plan_json.rb', line 224

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



230
231
232
 
# File 'lib/subskribe_sandbox/models/plan_json.rb', line 230

def hash
  [id, entity_ids, name, display_name, description, status, product_id, charges, currency, external_id, template_ids, custom_fields, updated_on].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



174
175
176
177
178
179
180
181
 
# File 'lib/subskribe_sandbox/models/plan_json.rb', line 174

def list_invalid_properties
  invalid_properties = Array.new
  if @status.nil?
    invalid_properties.push('invalid value for "status", status 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



304
305
306
 
# File 'lib/subskribe_sandbox/models/plan_json.rb', line 304

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



310
311
312
313
314
315
316
317
318
 
# File 'lib/subskribe_sandbox/models/plan_json.rb', line 310

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



298
299
300
 
# File 'lib/subskribe_sandbox/models/plan_json.rb', line 298

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



185
186
187
188
189
190
 
# File 'lib/subskribe_sandbox/models/plan_json.rb', line 185

def valid?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ['DRAFT', 'ACTIVE', 'GRANDFATHERED', 'ARCHIVED', 'DEPRECATED'])
  return false unless status_validator.valid?(@status)
  true
end