ultracart_api 3.9.1 → 3.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 712bf0471253bf7a1e158a9bb195be9c21a76540aa7c876fb67e6e7100ebc036
-  data.tar.gz: 1ee3ed296ba6e3e740256894a04aed3837953b3eb0461bf1f15785766571a4ae
+  metadata.gz: c21e0fbeb29a599225941362bbfd5a4fa38d1608c86df5089f33cdfcec08ad3b
+  data.tar.gz: 70f55016e1557be86277dec10d59e0bd0048a8f9bd2340d3e6567a942bb6a85d
 SHA512:
-  metadata.gz: 98c9eb555e6ec5884c5ed82c219e10bc6c3bc14acb583ecde03b364074e9df5619ec2741ccb1529cdc45c1b1ac2635fb57ff3e82beca1178e5eab537469b805b
-  data.tar.gz: ba674c5eda0a756924e1690c104727ad3254fe7b347dd23d1c11b5309a2a6a4ec08bcc0a305784e89e99e2eb227f26f5e5c14612fd268040d5b6bb4540919c3b
+  metadata.gz: 6186b4eab4833f0150ed24869b93524146f6bebc9c4028a7b092fa39f045c1d525a97b6ae6f60ad9d088e413b8deef821e8fd9eee15b9839a5061cb296763fa9
+  data.tar.gz: 9db3605fb5364fa06c971a25b3a745c5d8277ddef0f6fd06e79a2b8e17b8f429af16d83313ed3d091830f243b69251a960e41d567509b6d855a372289fd092e4

data/README.md

@@ -7,7 +7,7 @@ UltraCart REST API Version 2
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 2.0.0
-- Package version: 3.9.1
+- Package version: 3.9.2
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
 
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-3.9.1.gem
+gem install ./ultracart_api-3.9.2.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.9.1.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.9.2.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'ultracart_api', '~> 3.9.1'
+    gem 'ultracart_api', '~> 3.9.2'
 
 ### Install from Git
 
@@ -465,6 +465,10 @@ Class | Method | HTTP request | Description
  - [UltracartClient::AutoOrdersResponse](docs/AutoOrdersResponse.md)
  - [UltracartClient::AvalaraConfig](docs/AvalaraConfig.md)
  - [UltracartClient::BaseResponse](docs/BaseResponse.md)
+ - [UltracartClient::Browser](docs/Browser.md)
+ - [UltracartClient::BrowserDevice](docs/BrowserDevice.md)
+ - [UltracartClient::BrowserOS](docs/BrowserOS.md)
+ - [UltracartClient::BrowserUserAgent](docs/BrowserUserAgent.md)
  - [UltracartClient::Cart](docs/Cart.md)
  - [UltracartClient::CartAffiliate](docs/CartAffiliate.md)
  - [UltracartClient::CartAffirmCheckoutResponse](docs/CartAffirmCheckoutResponse.md)
@@ -1113,8 +1117,6 @@ Class | Method | HTTP request | Description
   - customer_write: Allows you to write customer information.
   - fulfillment_read: Allows you to read fulfillment information.
   - fulfillment_write: Allows you to write fulfillment information.
-  - gift_certificate_read: Allows you to read gift certificate information.
-  - gift_certificate_write: Allows you to write gift certificate information.
   - integration_log_read: Allows you to read integration log information.
   - integration_log_write: Allows you to write integration log information.
   - order_read: Allows you to read order information.
@@ -1131,6 +1133,8 @@ Class | Method | HTTP request | Description
   - ultrabooks_write: 2 of 2 required to use UltraBooks
   - user_read: Allows you to read user information.
   - user_write: Allows you to write user information.
+  - gift_certificate_read: Allows you to read gift certificate information.
+  - gift_certificate_write: Allows you to write gift certificate information.
 
 ### ultraCartSimpleApiKey
 
@@ -1146,6 +1150,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.9.2 | 04/04/2022 | user.email field extended and postcard screenshot fields |
 | 3.9.1 | 03/03/2022 | javascript sdk package.json bug fix |
 | 3.9.0 | 03/03/2022 | removed  ultra_cart_rest_api_v2.d.ts from javascript sdk because typescript sdk exists now |
 | 3.8.8 | 03/02/2022 | bug fix for ruby sdk, uri.escape deprecated in 3.x |

data/docs/AddLibraryItemRequest.md

@@ -5,6 +5,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **attributes** | [**Array<LibraryItemAttribute>**](LibraryItemAttribute.md) | Attributes associated with the library item to contain additional configuration. | [optional] 
 **cjson** | **String** | Cjson to be added to library | [optional] 
+**cjson2** | **String** | Additional Cjson to be added to library, notably for the postcard which has a front and back. | [optional] 
 **content_type** | **String** | flow, campaign, cjson, email, transactional_email, postcard or upsell | [optional] 
 **description** | **String** | description of library item | [optional] 
 **email_name** | **String** | Required if content_type is transactional_email. This is the name of the email template (html, not text).  This name should have a .vm file extension.  An example is auto_order_cancel_html.vm | [optional] 

data/docs/Browser.md

@@ -0,0 +1,10 @@
+# UltracartClient::Browser
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**device** | [**BrowserDevice**](BrowserDevice.md) |  | [optional] 
+**os** | [**BrowserOS**](BrowserOS.md) |  | [optional] 
+**user_agent** | [**BrowserUserAgent**](BrowserUserAgent.md) |  | [optional] 
+
+

data/docs/BrowserDevice.md

@@ -0,0 +1,8 @@
+# UltracartClient::BrowserDevice
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**family** | **String** |  | [optional] 
+
+

data/docs/BrowserOS.md

@@ -0,0 +1,12 @@
+# UltracartClient::BrowserOS
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**family** | **String** |  | [optional] 
+**major** | **String** |  | [optional] 
+**minor** | **String** |  | [optional] 
+**patch** | **String** |  | [optional] 
+**patch_minor** | **String** |  | [optional] 
+
+

data/docs/BrowserUserAgent.md

@@ -0,0 +1,11 @@
+# UltracartClient::BrowserUserAgent
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**family** | **String** |  | [optional] 
+**major** | **String** |  | [optional] 
+**minor** | **String** |  | [optional] 
+**patch** | **String** |  | [optional] 
+
+

data/docs/Cart.md

@@ -4,6 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **affiliate** | [**CartAffiliate**](CartAffiliate.md) |  | [optional] 
+**affiliate_network_pixel_oid** | **Integer** | The affiliate network pixel identifier associated with the cart | [optional] 
 **base_currency_code** | **String** | The ISO-4217 three letter base currency code of the account | [optional] 
 **billing** | [**CartBilling**](CartBilling.md) |  | [optional] 
 **buysafe** | [**CartBuysafe**](CartBuysafe.md) |  | [optional] 

data/docs/DistributionCenter.md

@@ -36,6 +36,7 @@ Name | Type | Description | Notes
 **shipment_cutoff_time_tuesday** | **String** | The time (EST) after which shipments will not be processed on Tuesday | [optional] 
 **shipment_cutoff_time_wednesday** | **String** | The time (EST) after which shipments will not be processed on Wednesday | [optional] 
 **state** | **String** | State of the distribution center | [optional] 
+**transmit_blank_costs** | **BOOLEAN** | True if monetary amounts should be zeroed before transmission | [optional] 
 **transport** | **String** | Transport mechanism for this distribution center | [optional] 
 
 

data/docs/EmailCommseqPostcard.md

@@ -13,6 +13,14 @@ Name | Type | Description | Notes
 **postcard_container_cjson_last_modified_dts** | **String** | Timestamp the last time the container was modified. | [optional] 
 **postcard_front_container_cjson** | **String** | Postcard front container cjson | [optional] 
 **postcard_front_container_uuid** | **String** | Postcard front container uuid | [optional] 
+**screenshot_back_large_full_url** | **String** | URL to screenshot (back) in large form factor full page | [optional] 
+**screenshot_back_large_viewport_url** | **String** | URL to screenshot (back) in large form factor viewport | [optional] 
+**screenshot_back_small_full_url** | **String** | URL to screenshot (back) in small form factor full page | [optional] 
+**screenshot_back_small_viewport_url** | **String** | URL to screenshot (back) in small form factor viewport | [optional] 
+**screenshot_large_full_url** | **String** | URL to screenshot in large form factor full page | [optional] 
+**screenshot_large_viewport_url** | **String** | URL to screenshot in large form factor viewport | [optional] 
+**screenshot_small_full_url** | **String** | URL to screenshot in small form factor full page | [optional] 
+**screenshot_small_viewport_url** | **String** | URL to screenshot in small form factor viewport | [optional] 
 **storefront_oid** | **Integer** | Storefront oid | [optional] 
 
 

data/docs/GiftCertificate.md

@@ -5,10 +5,12 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **activated** | **BOOLEAN** | True if this gift certificate is activated and ready to apply to purchases. | [optional] 
 **code** | **String** | The code used by the customer to purchase against this gift certificate. | [optional] 
+**customer_profile_oid** | **Integer** | This is the customer profile oid associated with this internally managed gift certificate. | [optional] 
 **deleted** | **BOOLEAN** | True if this gift certificate was deleted. | [optional] 
 **email** | **String** | Email of the customer associated with this gift certificate. | [optional] 
 **expiration_dts** | **String** | Expiration date time. | [optional] 
 **gift_certificate_oid** | **Integer** | Gift certificate oid. | [optional] 
+**internal** | **BOOLEAN** | This is an internally managed gift certificate associated with the loyalty cash rewards program. | [optional] 
 **ledger_entries** | [**Array<GiftCertificateLedgerEntry>**](GiftCertificateLedgerEntry.md) | A list of all ledger activity for this gift certificate. | [optional] 
 **merchant_id** | **String** | Merchant Id | [optional] 
 **merchant_note** | **String** | A list of all ledger activity for this gift certificate. | [optional] 

data/docs/ItemTax.md

@@ -5,6 +5,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **exemptions** | [**Array<ItemTaxExemption>**](ItemTaxExemption.md) | Exemptions | [optional] 
 **tax_free** | **BOOLEAN** | True if tax free | [optional] 
+**tax_product_type** | **String** | Tax product type | [optional] 
 **taxable_cost** | **Float** | Taxable cost if different than regular cost | [optional] 
 
 

data/docs/OrderCheckout.md

@@ -3,6 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**browser** | [**Browser**](Browser.md) |  | [optional] 
 **comments** | **String** | Comments from the customer.  Rarely used on the single page checkout. | [optional] 
 **custom_field1** | **String** | Custom field 1 | [optional] 
 **custom_field2** | **String** | Custom field 2 | [optional] 
@@ -13,6 +14,7 @@ Name | Type | Description | Notes
 **custom_field7** | **String** | Custom field 7 | [optional] 
 **customer_ip_address** | **String** | IP address of the customer when placing the order | [optional] 
 **screen_branding_theme_code** | **String** | Screen branding theme code associated with the order (legacy checkout) | [optional] 
+**screen_size** | **String** | Screen size small, medium or large | [optional] 
 **storefront_host_name** | **String** | StoreFront host name associated with the order | [optional] 
 **upsell_path_code** | **String** | Upsell path code assigned during the checkout that the customer went through | [optional] 
 

data/docs/OrderItem.md

@@ -49,6 +49,7 @@ Name | Type | Description | Notes
 **special_product_type** | **String** | Special product type (USPS Media Mail) | [optional] 
 **tags** | [**Array<OrderItemTag>**](OrderItemTag.md) | Tags | [optional] 
 **tax_free** | **BOOLEAN** | True if the item is tax free | [optional] 
+**tax_product_type** | **String** | Type of product for tax purposes (self or UltraCart Managed taxes) | [optional] 
 **taxable_cost** | [**Currency**](Currency.md) |  | [optional] 
 **total_cost_with_discount** | [**Currency**](Currency.md) |  | [optional] 
 **total_refunded** | [**Currency**](Currency.md) |  | [optional] 

data/docs/TaxProviderUltraCartState.md

@@ -4,6 +4,9 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **enabled** | **BOOLEAN** | True if this state taxes are managed by UltraCart | [optional] 
+**exempt_digital_items** | **BOOLEAN** | True if digital items are exempt from sales tax in this state. | [optional] 
+**exempt_physical_items** | **BOOLEAN** | True if physical items are exempt from sales tax in this state. | [optional] 
+**exempt_service_items** | **BOOLEAN** | True if service items are exempt from sales tax in this state. | [optional] 
 **state_code** | **String** | State Code (2 digits) | [optional] 
 **state_name** | **String** | Fully spelled out state name | [optional] 
 **tax_gift_charge** | **BOOLEAN** | True if gift charges should be taxed in this state. | [optional] 

data/docs/TaxState.md

@@ -10,6 +10,9 @@ Name | Type | Description | Notes
 **dont_collect_county** | **BOOLEAN** | Flag instructing engine to not collect county tax for this state | [optional] 
 **dont_collect_postal_code** | **BOOLEAN** | Flag instructing engine to not collect postal code tax for this state | [optional] 
 **dont_collect_state** | **BOOLEAN** | Flag instructing engine to not collect state tax for this state | [optional] 
+**exempt_digital_items** | **BOOLEAN** | True if digital items are exempt from sales tax in this state. | [optional] 
+**exempt_physical_items** | **BOOLEAN** | True if physical items are exempt from sales tax in this state. | [optional] 
+**exempt_service_items** | **BOOLEAN** | True if service items are exempt from sales tax in this state. | [optional] 
 **state_code** | **String** | State code | [optional] 
 **state_oid** | **Integer** | Tax record object identifier used internally by database | [optional] 
 **tax_gift_charge** | **BOOLEAN** | True if taxation within this jurisdiction should charge tax on gift charge | [optional] 

data/lib/ultracart_api/models/add_library_item_request.rb

@@ -20,6 +20,9 @@ module UltracartClient
     # Cjson to be added to library
     attr_accessor :cjson
 
+    # Additional Cjson to be added to library, notably for the postcard which has a front and back.
+    attr_accessor :cjson2
+
     # flow, campaign, cjson, email, transactional_email, postcard or upsell
     attr_accessor :content_type
 
@@ -52,6 +55,7 @@ module UltracartClient
       {
         :'attributes' => :'attributes',
         :'cjson' => :'cjson',
+        :'cjson2' => :'cjson2',
         :'content_type' => :'content_type',
         :'description' => :'description',
         :'email_name' => :'email_name',
@@ -69,6 +73,7 @@ module UltracartClient
       {
         :'attributes' => :'Array<LibraryItemAttribute>',
         :'cjson' => :'String',
+        :'cjson2' => :'String',
         :'content_type' => :'String',
         :'description' => :'String',
         :'email_name' => :'String',
@@ -99,6 +104,10 @@ module UltracartClient
         self.cjson = attributes[:'cjson']
       end
 
+      if attributes.has_key?(:'cjson2')
+        self.cjson2 = attributes[:'cjson2']
+      end
+
       if attributes.has_key?(:'content_type')
         self.content_type = attributes[:'content_type']
       end
@@ -158,6 +167,7 @@ module UltracartClient
       self.class == o.class &&
           attributes == o.attributes &&
           cjson == o.cjson &&
+          cjson2 == o.cjson2 &&
           content_type == o.content_type &&
           description == o.description &&
           email_name == o.email_name &&
@@ -178,7 +188,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [attributes, cjson, content_type, description, email_name, email_path, screenshots, storefront_oid, title, upsell_offer_oid, uuid].hash
+      [attributes, cjson, cjson2, content_type, description, email_name, email_path, screenshots, storefront_oid, title, upsell_offer_oid, uuid].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/browser.rb

@@ -0,0 +1,202 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+OpenAPI spec version: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.15-SNAPSHOT
+
+=end
+
+require 'date'
+
+module UltracartClient
+  class Browser
+    attr_accessor :device
+
+    attr_accessor :os
+
+    attr_accessor :user_agent
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'device' => :'device',
+        :'os' => :'os',
+        :'user_agent' => :'user_agent'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'device' => :'BrowserDevice',
+        :'os' => :'BrowserOS',
+        :'user_agent' => :'BrowserUserAgent'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    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?(:'device')
+        self.device = attributes[:'device']
+      end
+
+      if attributes.has_key?(:'os')
+        self.os = attributes[:'os']
+      end
+
+      if attributes.has_key?(:'user_agent')
+        self.user_agent = attributes[:'user_agent']
+      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
+      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?
+      true
+    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 &&
+          device == o.device &&
+          os == o.os &&
+          user_agent == o.user_agent
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [device, os, user_agent].hash
+    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.swagger_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<(?<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 = UltracartClient.const_get(type).new
+        temp_model.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)
+        next if value.nil?
+        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

data/lib/ultracart_api/models/browser_device.rb

@@ -0,0 +1,184 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+OpenAPI spec version: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.15-SNAPSHOT
+
+=end
+
+require 'date'
+
+module UltracartClient
+  class BrowserDevice
+    attr_accessor :family
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'family' => :'family'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'family' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    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?(:'family')
+        self.family = attributes[:'family']
+      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
+      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?
+      true
+    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 &&
+          family == o.family
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [family].hash
+    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.swagger_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<(?<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 = UltracartClient.const_get(type).new
+        temp_model.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)
+        next if value.nil?
+        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