class HelloextendApiClient::Product
Attributes
Product
Brand, Manufacturer or Vendor
Product
category. Can be any value and may be used by Extend to map the product to warranty plans.
The timestamp when the object was created (internal)
Product
description
Enable/disable selling of warranties on this product
A url pointing to the primary image for the product
This is the id of the parent product, if there is one. This allows nesting of a single parent product with multiple variants (such as multiple color options for the same product)
A list of all extended warranty plans for which the product is eligible, listed by planId. The Offers SDK or Offers API will provide more detail about which plan options to display for a given product at a given time.
The base retail price of the product (in cents)
This is the unique identifier that identifies the product. This can be a product SKU, or variant id.
Product
name
The timestamp when the object was last updated (internal)
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/helloextend_api_client/models/product.rb, line 82 def self.attribute_map { :'brand' => :'brand', :'category' => :'category', :'created_at' => :'createdAt', :'description' => :'description', :'enabled' => :'enabled', :'image_url' => :'imageUrl', :'mfr_warranty' => :'mfrWarranty', :'price' => :'price', :'title' => :'title', :'updated_at' => :'updatedAt', :'status' => :'status', :'reference_id' => :'referenceId', :'parent_reference_id' => :'parentReferenceId', :'plans' => :'plans', :'identifiers' => :'identifiers' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/helloextend_api_client/models/product.rb, line 318 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/helloextend_api_client/models/product.rb, line 131 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `HelloextendApiClient::Product` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `HelloextendApiClient::Product`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:'brand') self.brand = attributes[:'brand'] end if attributes.key?(:'category') self.category = attributes[:'category'] end if attributes.key?(:'created_at') self.created_at = attributes[:'created_at'] end if attributes.key?(:'description') self.description = attributes[:'description'] end if attributes.key?(:'enabled') self.enabled = attributes[:'enabled'] end if attributes.key?(:'image_url') self.image_url = attributes[:'image_url'] end if attributes.key?(:'mfr_warranty') self.mfr_warranty = attributes[:'mfr_warranty'] end if attributes.key?(:'price') self.price = attributes[:'price'] end if attributes.key?(:'title') self.title = attributes[:'title'] end if attributes.key?(:'updated_at') self.updated_at = attributes[:'updated_at'] end if attributes.key?(:'status') self.status = attributes[:'status'] end if attributes.key?(:'reference_id') self.reference_id = attributes[:'reference_id'] end if attributes.key?(:'parent_reference_id') self.parent_reference_id = attributes[:'parent_reference_id'] end if attributes.key?(:'plans') if (value = attributes[:'plans']).is_a?(Array) self.plans = value end end if attributes.key?(:'identifiers') self.identifiers = attributes[:'identifiers'] end end
List of attributes with nullable: true
# File lib/helloextend_api_client/models/product.rb, line 124 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/helloextend_api_client/models/product.rb, line 103 def self.openapi_types { :'brand' => :'String', :'category' => :'String', :'created_at' => :'Float', :'description' => :'String', :'enabled' => :'Boolean', :'image_url' => :'String', :'mfr_warranty' => :'ProductMfrWarranty', :'price' => :'Float', :'title' => :'String', :'updated_at' => :'Float', :'status' => :'String', :'reference_id' => :'String', :'parent_reference_id' => :'String', :'plans' => :'Array<String>', :'identifiers' => :'ProductIdentifiers' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/helloextend_api_client/models/product.rb, line 283 def ==(o) return true if self.equal?(o) self.class == o.class && brand == o.brand && category == o.category && created_at == o.created_at && description == o.description && enabled == o.enabled && image_url == o.image_url && mfr_warranty == o.mfr_warranty && price == o.price && title == o.title && updated_at == o.updated_at && status == o.status && reference_id == o.reference_id && parent_reference_id == o.parent_reference_id && plans == o.plans && identifiers == o.identifiers end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/helloextend_api_client/models/product.rb, line 346 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 HelloextendApiClient.const_get(type).build_from_hash(value) end end
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/helloextend_api_client/models/product.rb, line 415 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/helloextend_api_client/models/product.rb, line 325 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.openapi_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that 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
Custom attribute writer method with validation @param [Object] description Value to be assigned
# File lib/helloextend_api_client/models/product.rb, line 249 def description=(description) if !description.nil? && description.to_s.length > 2000 fail ArgumentError, 'invalid value for "description", the character length must be smaller than or equal to 2000.' end @description = description end
@see the `==` method @param [Object] Object to be compared
# File lib/helloextend_api_client/models/product.rb, line 305 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/helloextend_api_client/models/product.rb, line 311 def hash [brand, category, created_at, description, enabled, image_url, mfr_warranty, price, title, updated_at, status, reference_id, parent_reference_id, plans, identifiers].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/helloextend_api_client/models/product.rb, line 209 def list_invalid_properties invalid_properties = Array.new if !@description.nil? && @description.to_s.length > 2000 invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 2000.') end if @price.nil? invalid_properties.push('invalid value for "price", price cannot be nil.') end if @title.nil? invalid_properties.push('invalid value for "title", title cannot be nil.') end if @title.to_s.length > 255 invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 255.') end if @reference_id.nil? invalid_properties.push('invalid value for "reference_id", reference_id cannot be nil.') end invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned
# File lib/helloextend_api_client/models/product.rb, line 273 def status=(status) validator = EnumAttributeValidator.new('String', ["new", "updated", "active", "inactive"]) unless validator.valid?(status) fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}." end @status = status end
Custom attribute writer method with validation @param [Object] title Value to be assigned
# File lib/helloextend_api_client/models/product.rb, line 259 def title=(title) if title.nil? fail ArgumentError, 'title cannot be nil' end if title.to_s.length > 255 fail ArgumentError, 'invalid value for "title", the character length must be smaller than or equal to 255.' end @title = title end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/helloextend_api_client/models/product.rb, line 397 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = self.class.openapi_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/helloextend_api_client/models/product.rb, line 385 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/helloextend_api_client/models/product.rb, line 236 def valid? return false if !@description.nil? && @description.to_s.length > 2000 return false if @price.nil? return false if @title.nil? return false if @title.to_s.length > 255 status_validator = EnumAttributeValidator.new('String', ["new", "updated", "active", "inactive"]) return false unless status_validator.valid?(@status) return false if @reference_id.nil? true end