Class: WalleeRubySdk::Scope

Inherits:
Object
  • Object
show all
Defined in:
lib/wallee-ruby-sdk/models/scope.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Scope

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
171
172
173
174
175
176
177
178
179
180
181
182
183
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
 
# File 'lib/wallee-ruby-sdk/models/scope.rb', line 142

def initialize(attributes = {})
  unless attributes.is_a?(Hash)
    fail ArgumentError, "The input argument (attributes) must be a hash in `WalleeRubySdk::Scope` 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|
    unless self.class.attribute_map.key?(k.to_sym)
      fail ArgumentError, "`#{k}` is not a valid attribute in `WalleeRubySdk::Scope`. 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?(:'planned_purge_date')
    self.planned_purge_date = attributes[:'planned_purge_date']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#domain_name ⇒ Object

The domain name that belongs to the scope.



54
55
56
 
# File 'lib/wallee-ruby-sdk/models/scope.rb', line 54

def domain_name
  @domain_name
end

#features ⇒ Object

The list of features that are active in the scope.



42
43
44
 
# File 'lib/wallee-ruby-sdk/models/scope.rb', line 42

def features
  @features
end

#id ⇒ Object

A unique identifier for the object.



60
61
62
 
# File 'lib/wallee-ruby-sdk/models/scope.rb', line 60

def id
  @id
end

#machine_name ⇒ Object

The name identifying the scope in e.g. URLs.



36
37
38
 
# File 'lib/wallee-ruby-sdk/models/scope.rb', line 36

def machine_name
  @machine_name
end

#name ⇒ Object

The name used to identify the scope.



57
58
59
 
# File 'lib/wallee-ruby-sdk/models/scope.rb', line 57

def name
  @name
end

#planned_purge_date ⇒ Object

The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.



27
28
29
 
# File 'lib/wallee-ruby-sdk/models/scope.rb', line 27

def planned_purge_date
  @planned_purge_date
end

#port ⇒ Object

The port where the scope can be accessed.



48
49
50
 
# File 'lib/wallee-ruby-sdk/models/scope.rb', line 48

def port
  @port
end

#preprod_domain_name ⇒ Object

The preprod domain name that belongs to the scope.



51
52
53
 
# File 'lib/wallee-ruby-sdk/models/scope.rb', line 51

def preprod_domain_name
  @preprod_domain_name
end

#sandbox_domain_name ⇒ Object

The sandbox domain name that belongs to the scope.



65
66
67
 
# File 'lib/wallee-ruby-sdk/models/scope.rb', line 65

def sandbox_domain_name
  @sandbox_domain_name
end

#ssl_active ⇒ Object

Whether the scope supports SSL.



30
31
32
 
# File 'lib/wallee-ruby-sdk/models/scope.rb', line 30

def ssl_active
  @ssl_active
end

#state ⇒ Object

Returns the value of attribute state.



62
63
64
 
# File 'lib/wallee-ruby-sdk/models/scope.rb', line 62

def state
  @state
end

#themes ⇒ Object

The themes that determine the look and feel of the scope’s user interface. A fall-through strategy is applied when building the actual theme.



45
46
47
 
# File 'lib/wallee-ruby-sdk/models/scope.rb', line 45

def themes
  @themes
end

#url ⇒ Object

The URL where the scope can be accessed.



39
40
41
 
# File 'lib/wallee-ruby-sdk/models/scope.rb', line 39

def url
  @url
end

#version ⇒ Object

The version is used for optimistic locking and incremented whenever the object is updated.



33
34
35
 
# File 'lib/wallee-ruby-sdk/models/scope.rb', line 33

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



425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'lib/wallee-ruby-sdk/models/scope.rb', line 425

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



110
111
112
 
# File 'lib/wallee-ruby-sdk/models/scope.rb', line 110

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/wallee-ruby-sdk/models/scope.rb', line 90

def self.attribute_map
  {
    :'planned_purge_date' => :'plannedPurgeDate',
    :'ssl_active' => :'sslActive',
    :'version' => :'version',
    :'machine_name' => :'machineName',
    :'url' => :'url',
    :'features' => :'features',
    :'themes' => :'themes',
    :'port' => :'port',
    :'preprod_domain_name' => :'preprodDomainName',
    :'domain_name' => :'domainName',
    :'name' => :'name',
    :'id' => :'id',
    :'state' => :'state',
    :'sandbox_domain_name' => :'sandboxDomainName'
  }
end

.build_from_hash(attributes) ⇒ Object

Returns the model itself

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/wallee-ruby-sdk/models/scope.rb', line 401

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



135
136
137
138
 
# File 'lib/wallee-ruby-sdk/models/scope.rb', line 135

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

.openapi_types ⇒ Object

Attribute type mapping.



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/wallee-ruby-sdk/models/scope.rb', line 115

def self.openapi_types
  {
    :'planned_purge_date' => :'Time',
    :'ssl_active' => :'Boolean',
    :'version' => :'Integer',
    :'machine_name' => :'String',
    :'url' => :'String',
    :'features' => :'Array<Feature>',
    :'themes' => :'Array<String>',
    :'port' => :'Integer',
    :'preprod_domain_name' => :'String',
    :'domain_name' => :'String',
    :'name' => :'String',
    :'id' => :'Integer',
    :'state' => :'CreationEntityState',
    :'sandbox_domain_name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/wallee-ruby-sdk/models/scope.rb', line 369

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      planned_purge_date == o.planned_purge_date &&
      ssl_active == o.ssl_active &&
      version == o.version &&
      machine_name == o.machine_name &&
      url == o.url &&
      features == o.features &&
      themes == o.themes &&
      port == o.port &&
      preprod_domain_name == o.preprod_domain_name &&
      domain_name == o.domain_name &&
      name == o.name &&
      id == o.id &&
      state == o.state &&
      sandbox_domain_name == o.sandbox_domain_name
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



496
497
498
499
500
501
502
503
504
505
506
507
508
 
# File 'lib/wallee-ruby-sdk/models/scope.rb', line 496

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


390
391
392
 
# File 'lib/wallee-ruby-sdk/models/scope.rb', line 390

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



396
397
398
 
# File 'lib/wallee-ruby-sdk/models/scope.rb', line 396

def hash
  [planned_purge_date, ssl_active, version, machine_name, url, features, themes, port, preprod_domain_name, domain_name, name, id, state, sandbox_domain_name].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



218
219
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
 
# File 'lib/wallee-ruby-sdk/models/scope.rb', line 218

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@machine_name.nil? && @machine_name.to_s.length > 50
    invalid_properties.push('invalid value for "machine_name", the character length must be smaller than or equal to 50.')
  end

  pattern = Regexp.new(/([A-Z][A-Za-z0-9]+)(_([A-Z][A-Za-z0-9]+))*/)
  if !@machine_name.nil? && @machine_name !~ pattern
    invalid_properties.push("invalid value for \"machine_name\", must conform to the pattern #{pattern}.")
  end

  if !@port.nil? && @port < 1
    invalid_properties.push('invalid value for "port", must be greater than or equal to 1.')
  end

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

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

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

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



472
473
474
 
# File 'lib/wallee-ruby-sdk/models/scope.rb', line 472

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



478
479
480
481
482
483
484
485
486
487
488
489
490
 
# File 'lib/wallee-ruby-sdk/models/scope.rb', line 478

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



466
467
468
 
# File 'lib/wallee-ruby-sdk/models/scope.rb', line 466

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



255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/wallee-ruby-sdk/models/scope.rb', line 255

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@machine_name.nil? && @machine_name.to_s.length > 50
  pattern = Regexp.new(/([A-Z][A-Za-z0-9]+)(_([A-Z][A-Za-z0-9]+))*/)
  return false if !@machine_name.nil? && @machine_name !~ pattern
  return false if !@port.nil? && @port < 1
  return false if !@preprod_domain_name.nil? && @preprod_domain_name.to_s.length > 40
  return false if !@domain_name.nil? && @domain_name.to_s.length > 40
  return false if !@name.nil? && @name.to_s.length > 50
  return false if !@sandbox_domain_name.nil? && @sandbox_domain_name.to_s.length > 40
  true
end