class SwaggerClient::AddClientToEnrollmentRequest

Attributes

class_schedule_id[RW]

The ID of the class schedule (enrollment) into which the client is being booked.

client_id[RW]

The ID of the client who is being booked into the enrollment.

enroll_date_forward[RW]

Enroll the clients from this date forward. `EnrollDateForward` takes priority over open enrollment.

enroll_open[RW]

Enroll for selected days.

send_email[RW]

When `true`, indicates that the client should be sent an email. An email is only sent if the client has an email address and automatic emails have been set up.<br /> Default: false

test[RW]

When `true`, input information is validated, but not committed.<br /> Default: false

waitlist[RW]

When `true`, the client is added to a specific enrollments waiting list.

waitlist_entry_id[RW]

The waiting list entry to add. Used to add a client to an enrollment from a waiting list entry.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/swagger_client/models/add_client_to_enrollment_request.rb, line 42
def self.attribute_map
  {
    :'client_id' => :'ClientId',
    :'class_schedule_id' => :'ClassScheduleId',
    :'enroll_date_forward' => :'EnrollDateForward',
    :'enroll_open' => :'EnrollOpen',
    :'test' => :'Test',
    :'send_email' => :'SendEmail',
    :'waitlist' => :'Waitlist',
    :'waitlist_entry_id' => :'WaitlistEntryId'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/swagger_client/models/add_client_to_enrollment_request.rb, line 71
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?(:'ClientId')
    self.client_id = attributes[:'ClientId']
  end

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

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

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

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

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

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

  if attributes.has_key?(:'WaitlistEntryId')
    self.waitlist_entry_id = attributes[:'WaitlistEntryId']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/swagger_client/models/add_client_to_enrollment_request.rb, line 56
def self.swagger_types
  {
    :'client_id' => :'String',
    :'class_schedule_id' => :'Integer',
    :'enroll_date_forward' => :'DateTime',
    :'enroll_open' => :'Array<DateTime>',
    :'test' => :'BOOLEAN',
    :'send_email' => :'BOOLEAN',
    :'waitlist' => :'BOOLEAN',
    :'waitlist_entry_id' => :'Integer'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/swagger_client/models/add_client_to_enrollment_request.rb, line 137
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      client_id == o.client_id &&
      class_schedule_id == o.class_schedule_id &&
      enroll_date_forward == o.enroll_date_forward &&
      enroll_open == o.enroll_open &&
      test == o.test &&
      send_email == o.send_email &&
      waitlist == o.waitlist &&
      waitlist_entry_id == o.waitlist_entry_id
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/swagger_client/models/add_client_to_enrollment_request.rb, line 186
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 = SwaggerClient.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/swagger_client/models/add_client_to_enrollment_request.rb, line 252
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/swagger_client/models/add_client_to_enrollment_request.rb, line 165
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 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/swagger_client/models/add_client_to_enrollment_request.rb, line 152
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/swagger_client/models/add_client_to_enrollment_request.rb, line 158
def hash
  [client_id, class_schedule_id, enroll_date_forward, enroll_open, test, send_email, waitlist, waitlist_entry_id].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/swagger_client/models/add_client_to_enrollment_request.rb, line 114
def list_invalid_properties
  invalid_properties = Array.new
  if @client_id.nil?
    invalid_properties.push('invalid value for "client_id", client_id cannot be nil.')
  end

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

  invalid_properties
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/swagger_client/models/add_client_to_enrollment_request.rb, line 232
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/swagger_client/models/add_client_to_enrollment_request.rb, line 238
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/swagger_client/models/add_client_to_enrollment_request.rb, line 226
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/swagger_client/models/add_client_to_enrollment_request.rb, line 129
def valid?
  return false if @client_id.nil?
  return false if @class_schedule_id.nil?
  true
end