class PostFinanceCheckout::Space

Attributes

account[RW]

The account to which the space belongs to.

active[RW]

Active means that this account and all accounts in the hierarchy are active.

active_or_restricted_active[RW]

This property is true when all accounts in the hierarchy are active or restricted active.

created_by[RW]

The ID of the user who created this entity.

created_on[RW]

The date and time when this entity was created.

database[RW]

The database in which the space's data are stored in.

deleted_by[RW]

The ID of a user that deleted this entity.

deleted_on[RW]

The date and time when this entity was deleted.

id[RW]

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

last_modified_date[RW]
name[RW]

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.

planned_purge_date[RW]

The planned purge date indicates when the entity is permanently removed. When the date is null the entity is not planned to be removed.

postal_address[RW]

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

primary_currency[RW]

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

request_limit[RW]

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.

restricted_active[RW]

Restricted active means that at least one account in the hierarchy is only restricted active, but all are either restricted active or active.

state[RW]
technical_contact_addresses[RW]

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

time_zone[RW]

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.

version[RW]

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

Public Class Methods

attribute_map() click to toggle source

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

# File lib/postfinancecheckout-ruby-sdk/models/space.rb, line 84
def self.attribute_map
  {
    :'account' => :'account',
    :'active' => :'active',
    :'active_or_restricted_active' => :'activeOrRestrictedActive',
    :'created_by' => :'createdBy',
    :'created_on' => :'createdOn',
    :'database' => :'database',
    :'deleted_by' => :'deletedBy',
    :'deleted_on' => :'deletedOn',
    :'id' => :'id',
    :'last_modified_date' => :'lastModifiedDate',
    :'name' => :'name',
    :'planned_purge_date' => :'plannedPurgeDate',
    :'postal_address' => :'postalAddress',
    :'primary_currency' => :'primaryCurrency',
    :'request_limit' => :'requestLimit',
    :'restricted_active' => :'restrictedActive',
    :'state' => :'state',
    :'technical_contact_addresses' => :'technicalContactAddresses',
    :'time_zone' => :'timeZone',
    :'version' => :'version'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/postfinancecheckout-ruby-sdk/models/space.rb, line 137
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?(:'account')
    self.account = attributes[:'account']
  end

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

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

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

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

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

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

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

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

  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?(:'plannedPurgeDate')
    self.planned_purge_date = attributes[:'plannedPurgeDate']
  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?(:'restrictedActive')
    self.restricted_active = attributes[:'restrictedActive']
  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?(:'version')
    self.version = attributes[:'version']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/postfinancecheckout-ruby-sdk/models/space.rb, line 110
def self.swagger_types
  {
    :'account' => :'Account',
    :'active' => :'BOOLEAN',
    :'active_or_restricted_active' => :'BOOLEAN',
    :'created_by' => :'Integer',
    :'created_on' => :'DateTime',
    :'database' => :'TenantDatabase',
    :'deleted_by' => :'Integer',
    :'deleted_on' => :'DateTime',
    :'id' => :'Integer',
    :'last_modified_date' => :'DateTime',
    :'name' => :'String',
    :'planned_purge_date' => :'DateTime',
    :'postal_address' => :'SpaceAddress',
    :'primary_currency' => :'String',
    :'request_limit' => :'Integer',
    :'restricted_active' => :'BOOLEAN',
    :'state' => :'CreationEntityState',
    :'technical_contact_addresses' => :'Array<String>',
    :'time_zone' => :'String',
    :'version' => :'Integer'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/postfinancecheckout-ruby-sdk/models/space.rb, line 265
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      account == o.account &&
      active == o.active &&
      active_or_restricted_active == o.active_or_restricted_active &&
      created_by == o.created_by &&
      created_on == o.created_on &&
      database == o.database &&
      deleted_by == o.deleted_by &&
      deleted_on == o.deleted_on &&
      id == o.id &&
      last_modified_date == o.last_modified_date &&
      name == o.name &&
      planned_purge_date == o.planned_purge_date &&
      postal_address == o.postal_address &&
      primary_currency == o.primary_currency &&
      request_limit == o.request_limit &&
      restricted_active == o.restricted_active &&
      state == o.state &&
      technical_contact_addresses == o.technical_contact_addresses &&
      time_zone == o.time_zone &&
      version == o.version
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/postfinancecheckout-ruby-sdk/models/space.rb, line 326
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 = PostFinanceCheckout.const_get(type).new
    temp_model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/postfinancecheckout-ruby-sdk/models/space.rb, line 392
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/postfinancecheckout-ruby-sdk/models/space.rb, line 305
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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/postfinancecheckout-ruby-sdk/models/space.rb, line 292
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/postfinancecheckout-ruby-sdk/models/space.rb, line 298
def hash
  [account, active, active_or_restricted_active, created_by, created_on, database, deleted_by, deleted_on, id, last_modified_date, name, planned_purge_date, postal_address, primary_currency, request_limit, restricted_active, state, technical_contact_addresses, time_zone, version].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/postfinancecheckout-ruby-sdk/models/space.rb, line 228
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

  invalid_properties
end
name=(name) click to toggle source

Custom attribute writer method with validation @param [Object] name Value to be assigned

# File lib/postfinancecheckout-ruby-sdk/models/space.rb, line 251
def name=(name)
  if !name.nil? && name.to_s.length > 200
    fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 200.'
  end

  if !name.nil? && name.to_s.length < 3
    fail ArgumentError, 'invalid value for "name", the character length must be great than or equal to 3.'
  end

  @name = name
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/postfinancecheckout-ruby-sdk/models/space.rb, line 372
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/postfinancecheckout-ruby-sdk/models/space.rb, line 378
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/postfinancecheckout-ruby-sdk/models/space.rb, line 366
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/postfinancecheckout-ruby-sdk/models/space.rb, line 243
def valid?
  return false if !@name.nil? && @name.to_s.length > 200
  return false if !@name.nil? && @name.to_s.length < 3
  true
end