Class: WhiteLabelMachineName::SpaceUpdate

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SpaceUpdate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
134
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/space_update.rb', line 87

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#id ⇒ Object

The ID is the primary key of the entity. The ID identifies the entity uniquely.



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

def id
  @id
end

#last_modified_date ⇒ Object

Returns the value of attribute last_modified_date.



24
25
26
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/space_update.rb', line 24

def last_modified_date
  @last_modified_date
end

#name ⇒ Object

The space name is used internally to identify the space in administrative interfaces. For example it is used within search fields and hence it should be distinct and descriptive.



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

def name
  @name
end

#postal_address ⇒ Object

The address to use in communication with clients for example in email, documents etc.



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

def postal_address
  @postal_address
end

#primary_currency ⇒ Object

This is the currency that is used to display aggregated amounts in the space.



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

def primary_currency
  @primary_currency
end

#request_limit ⇒ Object

The request limit defines the maximum number of API request accepted within 2 minutes for this space. This limit can only be changed with special privileges.



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

def request_limit
  @request_limit
end

#state ⇒ Object

Returns the value of attribute state.



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

def state
  @state
end

#technical_contact_addresses ⇒ Object

The email address provided as contact addresses will be informed about technical issues or errors triggered by the space.



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

def technical_contact_addresses
  @technical_contact_addresses
end

#time_zone ⇒ Object

The time zone assigned to the space determines the time offset for calculating dates within the space. This is typically used for background processed which needs to be triggered on a specific hour within the day. Changing the space time zone will not change the display of dates.



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

def time_zone
  @time_zone
end

#version ⇒ Object

The version number indicates the version of the entity. The version is incremented whenever the entity is changed.



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

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/space_update.rb', line 54

def self.attribute_map
  {
    :'last_modified_date' => :'lastModifiedDate',
    :'name' => :'name',
    :'postal_address' => :'postalAddress',
    :'primary_currency' => :'primaryCurrency',
    :'request_limit' => :'requestLimit',
    :'state' => :'state',
    :'technical_contact_addresses' => :'technicalContactAddresses',
    :'time_zone' => :'timeZone',
    :'id' => :'id',
    :'version' => :'version'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/space_update.rb', line 70

def self.swagger_types
  {
    :'last_modified_date' => :'DateTime',
    :'name' => :'String',
    :'postal_address' => :'SpaceAddressCreate',
    :'primary_currency' => :'String',
    :'request_limit' => :'Integer',
    :'state' => :'CreationEntityState',
    :'technical_contact_addresses' => :'Array<String>',
    :'time_zone' => :'String',
    :'id' => :'Integer',
    :'version' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/space_update.rb', line 185

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      last_modified_date == o.last_modified_date &&
      name == o.name &&
      postal_address == o.postal_address &&
      primary_currency == o.primary_currency &&
      request_limit == o.request_limit &&
      state == o.state &&
      technical_contact_addresses == o.technical_contact_addresses &&
      time_zone == o.time_zone &&
      id == o.id &&
      version == o.version
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



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/space_update.rb', line 236

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



302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/space_update.rb', line 302

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



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/space_update.rb', line 215

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


202
203
204
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/space_update.rb', line 202

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



208
209
210
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/space_update.rb', line 208

def hash
  [last_modified_date, name, postal_address, primary_currency, request_limit, state, technical_contact_addresses, time_zone, id, version].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



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/space_update.rb', line 138

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

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

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

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



282
283
284
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/space_update.rb', line 282

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



288
289
290
291
292
293
294
295
296
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/space_update.rb', line 288

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



276
277
278
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/space_update.rb', line 276

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



161
162
163
164
165
166
167
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/space_update.rb', line 161

def valid?
  return false if !@name.nil? && @name.to_s.length > 200
  return false if !@name.nil? && @name.to_s.length < 3
  return false if @id.nil?
  return false if @version.nil?
  true
end