Class: PostfinancecheckoutRubySdk::Scope

Inherits:
Object
  • Object
show all
Defined in:
lib/postfinancecheckout-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



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
215
216
217
218
219
220
221
222
 
# File 'lib/postfinancecheckout-ruby-sdk/models/scope.rb', line 149

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `PostfinancecheckoutRubySdk::Scope` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `PostfinancecheckoutRubySdk::Scope`. Please check the name to make sure it's valid. List of attributes: " + acceptable_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.



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

def domain_name
  @domain_name
end

#features ⇒ Object

The list of features that are active in the scope.



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

def features
  @features
end

#id ⇒ Object

A unique identifier for the object.



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

def id
  @id
end

#machine_name ⇒ Object

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



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

def machine_name
  @machine_name
end

#name ⇒ Object

The name used to identify the scope.



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

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.



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

def planned_purge_date
  @planned_purge_date
end

#port ⇒ Object

The port where the scope can be accessed.



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

def port
  @port
end

#preprod_domain_name ⇒ Object

The preprod domain name that belongs to the scope.



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

def preprod_domain_name
  @preprod_domain_name
end

#sandbox_domain_name ⇒ Object

The sandbox domain name that belongs to the scope.



67
68
69
 
# File 'lib/postfinancecheckout-ruby-sdk/models/scope.rb', line 67

def sandbox_domain_name
  @sandbox_domain_name
end

#ssl_active ⇒ Object

Whether the scope supports SSL.



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

def ssl_active
  @ssl_active
end

#state ⇒ Object

Returns the value of attribute state.



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

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.



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

def themes
  @themes
end

#url ⇒ Object

The URL where the scope can be accessed.



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

def url
  @url
end

#version ⇒ Object

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



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

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



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
463
464
465
466
467
468
469
470
471
 
# File 'lib/postfinancecheckout-ruby-sdk/models/scope.rb', line 434

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 = PostfinancecheckoutRubySdk.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_attribute_map ⇒ Object

Returns attribute mapping this model knows about



112
113
114
 
# File 'lib/postfinancecheckout-ruby-sdk/models/scope.rb', line 112

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



117
118
119
 
# File 'lib/postfinancecheckout-ruby-sdk/models/scope.rb', line 117

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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

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

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/postfinancecheckout-ruby-sdk/models/scope.rb', line 410

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



142
143
144
145
 
# File 'lib/postfinancecheckout-ruby-sdk/models/scope.rb', line 142

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

.openapi_types ⇒ Object

Attribute type mapping.



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/postfinancecheckout-ruby-sdk/models/scope.rb', line 122

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



376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/postfinancecheckout-ruby-sdk/models/scope.rb', line 376

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



505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'lib/postfinancecheckout-ruby-sdk/models/scope.rb', line 505

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


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



403
404
405
 
# File 'lib/postfinancecheckout-ruby-sdk/models/scope.rb', line 403

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



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
257
258
259
 
# File 'lib/postfinancecheckout-ruby-sdk/models/scope.rb', line 226

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



481
482
483
 
# File 'lib/postfinancecheckout-ruby-sdk/models/scope.rb', line 481

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



487
488
489
490
491
492
493
494
495
496
497
498
499
 
# File 'lib/postfinancecheckout-ruby-sdk/models/scope.rb', line 487

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



475
476
477
 
# File 'lib/postfinancecheckout-ruby-sdk/models/scope.rb', line 475

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



263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/postfinancecheckout-ruby-sdk/models/scope.rb', line 263

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@machine_name.nil? && @machine_name.to_s.length > 50
  return false if !@machine_name.nil? && @machine_name !~ Regexp.new(/([A-Z][A-Za-z0-9]+)(_([A-Z][A-Za-z0-9]+))*/)
  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