class SamplifyAPIClient::Project

Attributes

category[RW]
devices[RW]

List of emails to subscribe to notifications

exclusions[RW]
ext_project_id[RW]

Unique external project ID

line_items[RW]

List of line items for the project.

notification_emails[RW]

List of emails to subscribe to notifications

title[RW]

Project title

Public Class Methods

attribute_map() click to toggle source

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

# File lib/samplify_api_client/models/project.rb, line 37
def self.attribute_map
  {
    :'category' => :'category',
    :'devices' => :'devices',
    :'exclusions' => :'exclusions',
    :'ext_project_id' => :'extProjectId',
    :'line_items' => :'lineItems',
    :'notification_emails' => :'notificationEmails',
    :'title' => :'title'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/samplify_api_client/models/project.rb, line 64
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?(:'category')
    self.category = attributes[:'category']
  end

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

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

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

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

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

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

Attribute type mapping.

# File lib/samplify_api_client/models/project.rb, line 50
def self.swagger_types
  {
    :'category' => :'ProjectCategoryData',
    :'devices' => :'Array<String>',
    :'exclusions' => :'ExclusionData',
    :'ext_project_id' => :'String',
    :'line_items' => :'Array<LineItemData>',
    :'notification_emails' => :'Array<String>',
    :'title' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/samplify_api_client/models/project.rb, line 145
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      category == o.category &&
      devices == o.devices &&
      exclusions == o.exclusions &&
      ext_project_id == o.ext_project_id &&
      line_items == o.line_items &&
      notification_emails == o.notification_emails &&
      title == o.title
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/samplify_api_client/models/project.rb, line 193
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 = SamplifyAPIClient.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/samplify_api_client/models/project.rb, line 259
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/samplify_api_client/models/project.rb, line 172
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/samplify_api_client/models/project.rb, line 159
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/samplify_api_client/models/project.rb, line 165
def hash
  [category, devices, exclusions, ext_project_id, line_items, notification_emails, title].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/samplify_api_client/models/project.rb, line 107
def list_invalid_properties
  invalid_properties = Array.new
  if @category.nil?
    invalid_properties.push('invalid value for "category", category cannot be nil.')
  end

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

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

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

  if @title.nil?
    invalid_properties.push('invalid value for "title", title 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/samplify_api_client/models/project.rb, line 239
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/samplify_api_client/models/project.rb, line 245
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/samplify_api_client/models/project.rb, line 233
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/samplify_api_client/models/project.rb, line 134
def valid?
  return false if @category.nil?
  return false if @ext_project_id.nil?
  return false if @line_items.nil?
  return false if @notification_emails.nil?
  return false if @title.nil?
  true
end