class SignRequestClient::Team

Attributes

delete_after[RW]

When filled this team will be deleted after this date

events_callback_url[RW]
members[RW]
name[RW]
phone[RW]
primary_color[RW]
sandbox[RW]

Indicates whether team is in Sandbox mode

subdomain[RW]
url[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/signrequest_client/models/team.rb, line 40
def self.attribute_map
  {
    :'name' => :'name',
    :'subdomain' => :'subdomain',
    :'url' => :'url',
    :'logo' => :'logo',
    :'phone' => :'phone',
    :'primary_color' => :'primary_color',
    :'events_callback_url' => :'events_callback_url',
    :'members' => :'members',
    :'delete_after' => :'delete_after',
    :'sandbox' => :'sandbox'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/signrequest_client/models/team.rb, line 73
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?(:'name')
    self.name = attributes[:'name']
  end

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

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

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

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

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

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

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

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

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

Attribute type mapping.

# File lib/signrequest_client/models/team.rb, line 56
def self.swagger_types
  {
    :'name' => :'String',
    :'subdomain' => :'String',
    :'url' => :'String',
    :'logo' => :'String',
    :'phone' => :'String',
    :'primary_color' => :'String',
    :'events_callback_url' => :'String',
    :'members' => :'Array<InlineTeamMember>',
    :'delete_after' => :'DateTime',
    :'sandbox' => :'BOOLEAN'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/signrequest_client/models/team.rb, line 257
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      subdomain == o.subdomain &&
      url == o.url &&
      logo == o.logo &&
      phone == o.phone &&
      primary_color == o.primary_color &&
      events_callback_url == o.events_callback_url &&
      members == o.members &&
      delete_after == o.delete_after &&
      sandbox == o.sandbox
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/signrequest_client/models/team.rb, line 308
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 = SignRequestClient.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/signrequest_client/models/team.rb, line 374
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/signrequest_client/models/team.rb, line 287
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/signrequest_client/models/team.rb, line 274
def eql?(o)
  self == o
end
events_callback_url=(events_callback_url) click to toggle source

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

# File lib/signrequest_client/models/team.rb, line 247
def events_callback_url=(events_callback_url)
  if !events_callback_url.nil? && events_callback_url.to_s.length > 2100
    fail ArgumentError, 'invalid value for "events_callback_url", the character length must be smaller than or equal to 2100.'
  end

  @events_callback_url = events_callback_url
end
hash() click to toggle source

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

# File lib/signrequest_client/models/team.rb, line 280
def hash
  [name, subdomain, url, logo, phone, primary_color, events_callback_url, members, delete_after, sandbox].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/signrequest_client/models/team.rb, line 124
def list_invalid_properties
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @name.to_s.length > 100
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 100.')
  end

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

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

  if @subdomain.to_s.length > 100
    invalid_properties.push('invalid value for "subdomain", the character length must be smaller than or equal to 100.')
  end

  if @subdomain.to_s.length < 1
    invalid_properties.push('invalid value for "subdomain", the character length must be great than or equal to 1.')
  end

  if !@phone.nil? && @phone.to_s.length > 100
    invalid_properties.push('invalid value for "phone", the character length must be smaller than or equal to 100.')
  end

  if !@primary_color.nil? && @primary_color.to_s.length > 100
    invalid_properties.push('invalid value for "primary_color", the character length must be smaller than or equal to 100.')
  end

  if !@primary_color.nil? && @primary_color !~ Regexp.new(/^[#a-zA-Z0-9]+$/)
    invalid_properties.push('invalid value for "primary_color", must conform to the pattern /^[#a-zA-Z0-9]+$/.')
  end

  if !@events_callback_url.nil? && @events_callback_url.to_s.length > 2100
    invalid_properties.push('invalid value for "events_callback_url", the character length must be smaller than or equal to 2100.')
  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/signrequest_client/models/team.rb, line 187
def name=(name)
  if name.nil?
    fail ArgumentError, 'name cannot be nil'
  end

  if name.to_s.length > 100
    fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 100.'
  end

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

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

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

# File lib/signrequest_client/models/team.rb, line 223
def phone=(phone)
  if !phone.nil? && phone.to_s.length > 100
    fail ArgumentError, 'invalid value for "phone", the character length must be smaller than or equal to 100.'
  end

  @phone = phone
end
primary_color=(primary_color) click to toggle source

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

# File lib/signrequest_client/models/team.rb, line 233
def primary_color=(primary_color)
  if !primary_color.nil? && primary_color.to_s.length > 100
    fail ArgumentError, 'invalid value for "primary_color", the character length must be smaller than or equal to 100.'
  end

  if !primary_color.nil? && primary_color !~ Regexp.new(/^[#a-zA-Z0-9]+$/)
    fail ArgumentError, 'invalid value for "primary_color", must conform to the pattern /^[#a-zA-Z0-9]+$/.'
  end

  @primary_color = primary_color
end
subdomain=(subdomain) click to toggle source

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

# File lib/signrequest_client/models/team.rb, line 205
def subdomain=(subdomain)
  if subdomain.nil?
    fail ArgumentError, 'subdomain cannot be nil'
  end

  if subdomain.to_s.length > 100
    fail ArgumentError, 'invalid value for "subdomain", the character length must be smaller than or equal to 100.'
  end

  if subdomain.to_s.length < 1
    fail ArgumentError, 'invalid value for "subdomain", the character length must be great than or equal to 1.'
  end

  @subdomain = subdomain
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/signrequest_client/models/team.rb, line 354
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/signrequest_client/models/team.rb, line 360
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/signrequest_client/models/team.rb, line 348
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/signrequest_client/models/team.rb, line 171
def valid?
  return false if @name.nil?
  return false if @name.to_s.length > 100
  return false if @name.to_s.length < 1
  return false if @subdomain.nil?
  return false if @subdomain.to_s.length > 100
  return false if @subdomain.to_s.length < 1
  return false if !@phone.nil? && @phone.to_s.length > 100
  return false if !@primary_color.nil? && @primary_color.to_s.length > 100
  return false if !@primary_color.nil? && @primary_color !~ Regexp.new(/^[#a-zA-Z0-9]+$/)
  return false if !@events_callback_url.nil? && @events_callback_url.to_s.length > 2100
  true
end