class QwilAPI::PlatformSerializer

Attributes

accounts[RW]

The accounts configured for billing on this Platform.

automatic_debit[RW]

Flag specifying if the Platform's Invoices should be debited automatically.

contractors[RW]
create_invoice[RW]
currency[RW]

The ISO 4217 currency code for which all payments for this Platform are handled. Note: Immutable after Platform is created.

default_account[RW]

The account to use for billing purposes.

enable_emails[RW]

Flag indicating if we should send any emails to Users on this Platform. If not set, email checks fall through to global defaults.

income[RW]
income_requests[RW]

URL of the list of income requests.

invoices[RW]
is_demo_platform[RW]

If True, all users on this platform are demo users, and no payments will be debited/credited.

manager[RW]
membership_requests[RW]

URL of the list of platform membership requests.

memberships[RW]

URL of the list of Platform Memberships.

name[RW]
payment_date[RW]

The date that the first payment is due for the platform's pay cycle.

payment_schedule[RW]

The frequency of contractor rebates on this platform.

thumbnail_url[RW]
url[RW]
use_income_requests[RW]

If True, enable experimental IncomeRequest UI for this User.

validated[RW]

If True, this platform is has been validated as a real company.

xero_enabled[RW]

If True, this platform can enable the Xero integration.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/qwil_api/models/platform_serializer.rb, line 111
def self.attribute_map
  {
    :'url' => :'url',
    :'contractors' => :'contractors',
    :'income' => :'income',
    :'invoices' => :'invoices',
    :'create_invoice' => :'create_invoice',
    :'membership_requests' => :'membership_requests',
    :'income_requests' => :'income_requests',
    :'memberships' => :'memberships',
    :'name' => :'name',
    :'payment_schedule' => :'payment_schedule',
    :'payment_date' => :'payment_date',
    :'automatic_debit' => :'automatic_debit',
    :'currency' => :'currency',
    :'thumbnail_url' => :'thumbnail_url',
    :'validated' => :'validated',
    :'featured' => :'featured',
    :'is_demo_platform' => :'is_demo_platform',
    :'xero_enabled' => :'xero_enabled',
    :'use_income_requests' => :'use_income_requests',
    :'enable_emails' => :'enable_emails',
    :'default_account' => :'default_account',
    :'manager' => :'manager',
    :'accounts' => :'accounts'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/qwil_api/models/platform_serializer.rb, line 170
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?(:'url')
    self.url = attributes[:'url']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/qwil_api/models/platform_serializer.rb, line 140
def self.swagger_types
  {
    :'url' => :'String',
    :'contractors' => :'String',
    :'income' => :'String',
    :'invoices' => :'String',
    :'create_invoice' => :'String',
    :'membership_requests' => :'String',
    :'income_requests' => :'String',
    :'memberships' => :'String',
    :'name' => :'String',
    :'payment_schedule' => :'String',
    :'payment_date' => :'Date',
    :'automatic_debit' => :'BOOLEAN',
    :'currency' => :'String',
    :'thumbnail_url' => :'String',
    :'validated' => :'BOOLEAN',
    :'featured' => :'BOOLEAN',
    :'is_demo_platform' => :'BOOLEAN',
    :'xero_enabled' => :'BOOLEAN',
    :'use_income_requests' => :'BOOLEAN',
    :'enable_emails' => :'BOOLEAN',
    :'default_account' => :'String',
    :'manager' => :'String',
    :'accounts' => :'Array<String>'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/qwil_api/models/platform_serializer.rb, line 334
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      url == o.url &&
      contractors == o.contractors &&
      income == o.income &&
      invoices == o.invoices &&
      create_invoice == o.create_invoice &&
      membership_requests == o.membership_requests &&
      income_requests == o.income_requests &&
      memberships == o.memberships &&
      name == o.name &&
      payment_schedule == o.payment_schedule &&
      payment_date == o.payment_date &&
      automatic_debit == o.automatic_debit &&
      currency == o.currency &&
      thumbnail_url == o.thumbnail_url &&
      validated == o.validated &&
      featured == o.featured &&
      is_demo_platform == o.is_demo_platform &&
      xero_enabled == o.xero_enabled &&
      use_income_requests == o.use_income_requests &&
      enable_emails == o.enable_emails &&
      default_account == o.default_account &&
      manager == o.manager &&
      accounts == o.accounts
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/qwil_api/models/platform_serializer.rb, line 398
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 =~ /^(true|t|yes|y|1)$/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 = QwilAPI.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/qwil_api/models/platform_serializer.rb, line 464
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/qwil_api/models/platform_serializer.rb, line 377
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the 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
currency=(currency) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] currency Object to be assigned

# File lib/qwil_api/models/platform_serializer.rb, line 324
def currency=(currency)
  validator = EnumAttributeValidator.new('String', ["USD", "GBP"])
  unless validator.valid?(currency)
    fail ArgumentError, "invalid value for 'currency', must be one of #{validator.allowable_values}."
  end
  @currency = currency
end
eql?(o) click to toggle source

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

# File lib/qwil_api/models/platform_serializer.rb, line 364
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/qwil_api/models/platform_serializer.rb, line 370
def hash
  [url, contractors, income, invoices, create_invoice, membership_requests, income_requests, memberships, name, payment_schedule, payment_date, automatic_debit, currency, thumbnail_url, validated, featured, is_demo_platform, xero_enabled, use_income_requests, enable_emails, default_account, manager, accounts].hash
end
list_invalid_properties() click to toggle source

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

# File lib/qwil_api/models/platform_serializer.rb, line 274
def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end
payment_schedule=(payment_schedule) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] payment_schedule Object to be assigned

# File lib/qwil_api/models/platform_serializer.rb, line 314
def payment_schedule=(payment_schedule)
  validator = EnumAttributeValidator.new('String', ["WEEKLY", "FORTNIGHT", "MONTHLY", "DAILY"])
  unless validator.valid?(payment_schedule)
    fail ArgumentError, "invalid value for 'payment_schedule', must be one of #{validator.allowable_values}."
  end
  @payment_schedule = payment_schedule
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/qwil_api/models/platform_serializer.rb, line 444
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/qwil_api/models/platform_serializer.rb, line 450
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/qwil_api/models/platform_serializer.rb, line 438
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/qwil_api/models/platform_serializer.rb, line 281
def valid?
  return false if @url.nil?
  return false if @contractors.nil?
  return false if @income.nil?
  return false if @invoices.nil?
  return false if @create_invoice.nil?
  return false if @membership_requests.nil?
  return false if @income_requests.nil?
  return false if @memberships.nil?
  return false if @name.nil?
  return false if @payment_schedule.nil?
  payment_schedule_validator = EnumAttributeValidator.new('String', ["WEEKLY", "FORTNIGHT", "MONTHLY", "DAILY"])
  return false unless payment_schedule_validator.valid?(@payment_schedule)
  return false if @payment_date.nil?
  return false if @automatic_debit.nil?
  return false if @currency.nil?
  currency_validator = EnumAttributeValidator.new('String', ["USD", "GBP"])
  return false unless currency_validator.valid?(@currency)
  return false if @thumbnail_url.nil?
  return false if @validated.nil?
  return false if @featured.nil?
  return false if @is_demo_platform.nil?
  return false if @xero_enabled.nil?
  return false if @use_income_requests.nil?
  return false if @enable_emails.nil?
  return false if @default_account.nil?
  return false if @manager.nil?
  return false if @accounts.nil?
  return true
end