=begin
#Extend API Reference
## Introduction Welcome to the Extend API Documentation! Our goal is to make your integration as clear and easy as possible, so if you have feedback or suggestions for our API or reference docs, [please let us know](mailto:devs@helloextend.com). If you are implementing the API for the first time, please use the latest \"2019-08-01\" API version. If you have already implemented the API and haven't specified a version, you are on the \"Default\" API version. #### You can get up and running with Extend with just 5 simple steps: * Create an account with Extend, and get an access token from your Extend merchant portal * Sync your store's products to Extend * Get the relevant Extend warranty SKUs and add them to your store * Add the JS SDK snippets to your store's website, which will enable warranty offers to be displayed in your store * Record warranty purchases with Extend so we can create a new contract and deliver it to the customer, or record warranty returns / refunds so we can cancel the contract and account for the refunded amount
Pro Tip! Keep your store's products up to date
To make sure you are selling warranty plans on all eligible products (and not selling them on ineligible ones), it is best to keep your store's products in sync with Extend. If you update your products infrequently, it might be easiest to manually upload or edit products in your merchant portal. If you do update frequently, though, consider integrating with our Products API resource.
Need help? Contact us! We love to help!
The version of the OpenAPI document: Default
Generated by: https://openapi-generator.tech
OpenAPI Generator version: 4.3.1-SNAPSHOT
=end
require 'date'
module HelloextendApiClient
class Product
# Product Brand, Manufacturer or Vendor
attr_accessor :brand
# Product category. Can be any value and may be used by Extend to map the product to warranty plans.
attr_accessor :category
# The timestamp when the object was created (internal)
attr_accessor :created_at
# Product description
attr_accessor :description
# Enable/disable selling of warranties on this product
attr_accessor :enabled
# A url pointing to the primary image for the product
attr_accessor :image_url
attr_accessor :mfr_warranty
# The base retail price of the product (in cents)
attr_accessor :price
# Product name
attr_accessor :title
# The timestamp when the object was last updated (internal)
attr_accessor :updated_at
attr_accessor :status
# This is the unique identifier that identifies the product. This can be a product SKU, or variant id.
attr_accessor :reference_id
# 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)
attr_accessor :parent_reference_id
# 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.
attr_accessor :plans
attr_accessor :identifiers
class EnumAttributeValidator
attr_reader :datatype
attr_reader :allowable_values
def initialize(datatype, allowable_values)
@allowable_values = allowable_values.map do |value|
case datatype.to_s
when /Integer/i
value.to_i
when /Float/i
value.to_f
else
value
end
end
end
def valid?(value)
!value || allowable_values.include?(value)
end
end
# Attribute mapping from ruby-style variable name to JSON key.
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
# Attribute type mapping.
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',
:'identifiers' => :'ProductIdentifiers'
}
end
# List of attributes with nullable: true
def self.openapi_nullable
Set.new([
])
end
# Initializes the object
# @param [Hash] attributes Model attributes in the form of hash
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
# Show invalid properties with the reasons. Usually used together with valid?
# @return Array for valid properties with the reasons
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
# Check to see if the all the properties in the model are valid
# @return true if the model is valid
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
# Custom attribute writer method with validation
# @param [Object] description Value to be assigned
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
# Custom attribute writer method with validation
# @param [Object] title Value to be assigned
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
# Custom attribute writer method checking allowed values (enum).
# @param [Object] status Object to be assigned
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
# Checks equality by comparing each attribute.
# @param [Object] Object to be compared
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
# @see the `==` method
# @param [Object] Object to be compared
def eql?(o)
self == o
end
# Calculates hash code according to all attributes.
# @return [Integer] Hash code
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
# Builds the object from hash
# @param [Hash] attributes Model attributes in the form of hash
# @return [Object] Returns the model itself
def self.build_from_hash(attributes)
new.build_from_hash(attributes)
end
# Builds the object from hash
# @param [Hash] attributes Model attributes in the form of hash
# @return [Object] Returns the model itself
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
# Deserializes the data based on type
# @param string type Data type
# @param string value Value to be deserialized
# @return [Object] Deserialized data
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<(?.+)>\z/
inner_type = Regexp.last_match[:inner_type]
value.map { |v| _deserialize(inner_type, v) }
when /\AHash<(?.+?), (?.+)>\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
# Returns the string representation of the object
# @return [String] String presentation of the object
def to_s
to_hash.to_s
end
# to_body is an alias to to_hash (backward compatibility)
# @return [Hash] Returns the object in the form of hash
def to_body
to_hash
end
# Returns the object in the form of hash
# @return [Hash] Returns the object in the form of hash
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
# 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
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
end
end