class SwaggerClient::ClientContract

A client contract

Attributes

agreement_date[RW]

The date on which the contract was signed.

autopay_status[RW]

The status of the client’s autopay.

contract_name[RW]

The name of the contract.

end_date[RW]

The date that the contract expires.

id[RW]

The unique ID of the contract.

origination_location_id[RW]

The ID of the location where the contract was issued.

site_id[RW]

The ID of the site where the contract was issued.

start_date[RW]

The date that the contract became active.

upcoming_autopay_events[RW]

Contains details of the autopay events.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/swagger_client/models/client_contract.rb, line 68
def self.attribute_map
  {
    :'agreement_date' => :'AgreementDate',
    :'autopay_status' => :'AutopayStatus',
    :'contract_name' => :'ContractName',
    :'end_date' => :'EndDate',
    :'id' => :'Id',
    :'origination_location_id' => :'OriginationLocationId',
    :'start_date' => :'StartDate',
    :'site_id' => :'SiteId',
    :'upcoming_autopay_events' => :'UpcomingAutopayEvents'
  }
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/client_contract.rb, line 99
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?(:'AgreementDate')
    self.agreement_date = attributes[:'AgreementDate']
  end

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

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

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

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

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

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

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

  if attributes.has_key?(:'UpcomingAutopayEvents')
    if (value = attributes[:'UpcomingAutopayEvents']).is_a?(Array)
      self.upcoming_autopay_events = value
    end
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/swagger_client/models/client_contract.rb, line 83
def self.swagger_types
  {
    :'agreement_date' => :'DateTime',
    :'autopay_status' => :'String',
    :'contract_name' => :'String',
    :'end_date' => :'DateTime',
    :'id' => :'Integer',
    :'origination_location_id' => :'Integer',
    :'start_date' => :'DateTime',
    :'site_id' => :'Integer',
    :'upcoming_autopay_events' => :'Array<UpcomingAutopayEvent>'
  }
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/client_contract.rb, line 171
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      agreement_date == o.agreement_date &&
      autopay_status == o.autopay_status &&
      contract_name == o.contract_name &&
      end_date == o.end_date &&
      id == o.id &&
      origination_location_id == o.origination_location_id &&
      start_date == o.start_date &&
      site_id == o.site_id &&
      upcoming_autopay_events == o.upcoming_autopay_events
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/client_contract.rb, line 221
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/client_contract.rb, line 287
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
autopay_status=(autopay_status) click to toggle source

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

# File lib/swagger_client/models/client_contract.rb, line 161
def autopay_status=(autopay_status)
  validator = EnumAttributeValidator.new('String', ['Active', 'Inactive', 'Suspended'])
  unless validator.valid?(autopay_status)
    fail ArgumentError, 'invalid value for "autopay_status", must be one of #{validator.allowable_values}.'
  end
  @autopay_status = autopay_status
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/client_contract.rb, line 200
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/client_contract.rb, line 187
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/client_contract.rb, line 193
def hash
  [agreement_date, autopay_status, contract_name, end_date, id, origination_location_id, start_date, site_id, upcoming_autopay_events].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/client_contract.rb, line 146
def list_invalid_properties
  invalid_properties = Array.new
  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/client_contract.rb, line 267
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/client_contract.rb, line 273
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/client_contract.rb, line 261
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/client_contract.rb, line 153
def valid?
  autopay_status_validator = EnumAttributeValidator.new('String', ['Active', 'Inactive', 'Suspended'])
  return false unless autopay_status_validator.valid?(@autopay_status)
  true
end