square_connect 2.20190710.0.321 → 2.20190724.0.325

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18859f855d1baefc2c748115d7ed8c9d36110ac8535f1ccb11973558e40125d7
-  data.tar.gz: c52a038d30c7290fba1532f51c9ad82205d51659020f459934952cf103ae0142
+  metadata.gz: 5f81ce5506df0dc9ee3814901e34ad5db294260c926077931c2784b193eeceab
+  data.tar.gz: 9acfb905d67b80bf6557fb77e68262b9668337c05c4c47308cc87adc28efd67e
 SHA512:
-  metadata.gz: 88979e2eeb33a34da275418df013e51a070e8c67908b3cc481251ddd6317e800b93cd35630846418614cb419601dd5602c1013e5284b570a45e8fb376a2ce5bd
-  data.tar.gz: d73d34bf2c7dc9b4677b4c21ff943ea12b9613c386b977d35cb510b82f5536bb0c32b94a83145de5c8e7a90145c876bf1d8eb004af3fc1de293117ed143efa9f
+  metadata.gz: 43e374c72ea48241b23405323fb3b4dd0173a8f4b0223d44b610c1605dbd1d23f700a1621fdedc5a0dedac0780f6968a580060f72aa38d569c05b875728cab9c
+  data.tar.gz: 2cd26bff31b85c5c500d1c71ae9806121679bdcefbd21ed30e963c2eb63f7b6af8219de7519955f876246717b1717d09315739e244a5f53bc37c1c1700329c91

data/CHANGES.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## Version 2.20190724.0 (2019-07-24)
+
+* **BETA releases**:
+  * Catalog API: supports item options with datatypes and enums for item options and item option values.
+
 ## Version 2.20190710.0 (2019-07-10)
 
 * **Retired functionality** — The `CatalogItem.image_url` field (deprecated under `Square-Version` YYYYMMDD) is retired and no longer included in Connect SDKs.

data/README.md

@@ -10,7 +10,7 @@ for the specification and template files we used to generate this.
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 2.0
-- Package version: 2.20190710.0
+- Package version: 2.20190724.0
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 
 For more information, please visit [https://squareup.com/developers](https://squareup.com/developers)
@@ -252,6 +252,10 @@ Class | Method | HTTP request | Description
  - [SquareConnect::CatalogInfoResponseLimits](docs/CatalogInfoResponseLimits.md)
  - [SquareConnect::CatalogItem](docs/CatalogItem.md)
  - [SquareConnect::CatalogItemModifierListInfo](docs/CatalogItemModifierListInfo.md)
+ - [SquareConnect::CatalogItemOption](docs/CatalogItemOption.md)
+ - [SquareConnect::CatalogItemOptionForItem](docs/CatalogItemOptionForItem.md)
+ - [SquareConnect::CatalogItemOptionValue](docs/CatalogItemOptionValue.md)
+ - [SquareConnect::CatalogItemOptionValueForItemVariation](docs/CatalogItemOptionValueForItemVariation.md)
  - [SquareConnect::CatalogItemProductType](docs/CatalogItemProductType.md)
  - [SquareConnect::CatalogItemVariation](docs/CatalogItemVariation.md)
  - [SquareConnect::CatalogMeasurementUnit](docs/CatalogMeasurementUnit.md)
@@ -267,6 +271,8 @@ Class | Method | HTTP request | Description
  - [SquareConnect::CatalogProductSet](docs/CatalogProductSet.md)
  - [SquareConnect::CatalogQuery](docs/CatalogQuery.md)
  - [SquareConnect::CatalogQueryExact](docs/CatalogQueryExact.md)
+ - [SquareConnect::CatalogQueryItemVariationsForItemOptionValues](docs/CatalogQueryItemVariationsForItemOptionValues.md)
+ - [SquareConnect::CatalogQueryItemsForItemOptions](docs/CatalogQueryItemsForItemOptions.md)
  - [SquareConnect::CatalogQueryItemsForModifierList](docs/CatalogQueryItemsForModifierList.md)
  - [SquareConnect::CatalogQueryItemsForTax](docs/CatalogQueryItemsForTax.md)
  - [SquareConnect::CatalogQueryPrefix](docs/CatalogQueryPrefix.md)
@@ -678,7 +684,7 @@ Class | Method | HTTP request | Description
   - EMPLOYEES_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE`  Grants write access to employee profile information. For example, to create and modify employee profiles.
   - INVENTORY_READ: __HTTP Method__: `GET`  Grants read access to inventory information. For example, to call the RetrieveInventoryCount endpoint.
   - INVENTORY_WRITE: __HTTP Method__:  `POST`, `PUT`, `DELETE`  Grants write access to inventory information. For example, to call the BatchChangeInventory endpoint.
-  - ITEMS_READ: __HTTP Method__: `GET`  Grants read access to business and location information. For example, to obtain a location ID for subsequent activity.
+  - ITEMS_READ: __HTTP Method__: `GET`  Grants read access to product catalog information. For example, to get an  item or a list of items.
   - ITEMS_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE`  Grants write access to product catalog information. For example, to modify or add to a product catalog.
   - MERCHANT_PROFILE_READ: __HTTP Method__: `GET`  Grants read access to business and location information. For example, to obtain a location ID for subsequent activity.
   - ORDERS_READ: __HTTP Method__: `GET`  Grants read access to order information. For example, to call the BatchRetrieveOrders endpoint.

data/docs/CatalogItem.md

@@ -18,7 +18,8 @@ Name | Type | Description | Notes
 **tax_ids** | **Array<String>** | A set of IDs indicating the [CatalogTax](#type-catalogtax)es that are enabled for this item. When updating an item, any taxes listed here will be added to the item. [CatalogTax](#type-catalogtax)es may also be added to or deleted from an item using `UpdateItemTaxes`. | [optional] 
 **modifier_list_info** | [**Array<CatalogItemModifierListInfo>**](CatalogItemModifierListInfo.md) | A set of [CatalogItemModifierListInfo](#type-catalogitemmodifierlistinfo) objects representing the modifier lists that apply to this item, along with the overrides and min and max limits that are specific to this item. [CatalogModifierList](#type-catalogmodifierlist)s may also be added to or deleted from an item using `UpdateItemModifierLists`. | [optional] 
 **variations** | [**Array<CatalogObject>**](CatalogObject.md) | A list of [CatalogObject](#type-catalogobject)s containing the [CatalogItemVariation](#type-catalogitemvariation)s for this item.  Maximum: 250 item variations | [optional] 
-**product_type** | **String** | The product type of the item. May not be changed once an item has been created.  Only items of product type `REGULAR` may be created by this API; items with other product types are read-only. See [CatalogItemProductType](#type-catalogitemproducttype) for possible values | [optional] 
+**product_type** | **String** | The product type of the item. May not be changed once an item has been created.  Only items of product type `REGULAR` or `APPOINTMENTS_SERVICE` may be created by this API; items with other product types are read-only. See [CatalogItemProductType](#type-catalogitemproducttype) for possible values | [optional] 
 **skip_modifier_screen** | **BOOLEAN** | If `false`, the Square Point of Sale app will present the [CatalogItem](#type-catalogitem)'s details screen immediately, allowing the merchant to choose [CatalogModifier](#type-catalogmodifier)s before adding the item to the cart.  This is the default behavior.  If `true`, the Square Point of Sale app will immediately add the item to the cart with the pre-selected modifiers, and merchants can edit modifiers by drilling down onto the item's details.  Third-party clients are encouraged to implement similar behaviors. | [optional] 
+**item_options** | [**Array<CatalogItemOptionForItem>**](CatalogItemOptionForItem.md) | List of item options IDs for this item. Used to manage and group item variations in a specified order.  Maximum: 6 item options. | [optional] 
 
 

data/docs/CatalogItemOption.md

@@ -0,0 +1,17 @@
+# SquareConnect::CatalogItemOption
+
+### Description
+
+A group of variations for a [CatalogItem](#type-catalogitem)'s.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The item option's display name for the seller. Must be unique across all item options. Searchable. | [optional] 
+**display_name** | **String** | The item option's display name for the customer. Searchable. | [optional] 
+**description** | **String** | The item option's human-readable description. Displays for in the Square Point of Sale app for the seller and in the Online Store or on receipts for the buyer. | [optional] 
+**show_colors** | **BOOLEAN** | If true, display colors for entries in `values` when present. | [optional] 
+**values** | [**Array<CatalogObject>**](CatalogObject.md) | A list of [CatalogObject](#type-catalogobject)s containing the [CatalogItemOptionValue](#type-catalogitemoptionvalue)s for this item. | [optional] 
+**item_count** | **Integer** | The number of [CatalogItem](#type-catalogitem)s currently associated with this item option. Present only if the `include_counts` was specified in the request. Any count over 100 will be returned as `100`. | [optional] 
+
+

data/docs/CatalogItemOptionForItem.md

@@ -0,0 +1,12 @@
+# SquareConnect::CatalogItemOptionForItem
+
+### Description
+
+ A list of item option values that can be assigned to item variations. For example, a t-shirt item may offer a color option or a size option.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**item_option_id** | **String** | The unique id of the item option, used to form the dimensions of the item option matrix in a specified order. | [optional] 
+
+

data/docs/CatalogItemOptionValue.md

@@ -0,0 +1,17 @@
+# SquareConnect::CatalogItemOptionValue
+
+### Description
+
+An enumerated value that can link a [CatalogItemVariation(#type-catalogitemvariation) to an item option as one of its item option values.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**item_option_id** | **String** | Unique ID of the associated item option. | [optional] 
+**name** | **String** | Name of this item option value. Searchable. | [optional] 
+**description** | **String** | The option value's human-readable description. | [optional] 
+**color** | **String** | The HTML color for this value in the format #FFRRGGBB or #RRGGBB (e.g., \"#ff8d4e85\"). Only displayed if parent Item Option's `show_colors` flag is enabled. value. | [optional] 
+**ordinal** | **Integer** | Determines where this option value appears in a list of option values. | [optional] 
+**item_variation_count** | **Integer** | The number of [CatalogItemVariation(#type-catalogitemvariation)s that currently make use of this Item Option value. Present only if `retrieve_counts` was specified on the request used to retrieve the parent Item Option of this value.  Maximum: 100 counts. | [optional] 
+
+

data/docs/CatalogItemOptionValueForItemVariation.md

@@ -0,0 +1,13 @@
+# SquareConnect::CatalogItemOptionValueForItemVariation
+
+### Description
+
+A [CatalogItemOptionValue](#type-catalogitemoptionvalue) links an item variation to an item option as an item option value. For example, a t-shirt item may offer a color option and a size option. An item option value would represent each variation of t-shirt: For example, “Color:Red, Size:Small” or “Color:Blue, Size:Medium”.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**item_option_id** | **String** | The unique id of an item option. | [optional] 
+**item_option_value_id** | **String** | The unique id of the selected value for the item option. | [optional] 
+
+

data/docs/CatalogItemProductType.md

@@ -2,7 +2,7 @@
 
 ### Description
 
-The type of a [CatalogItem](#type-catalogitem). Connect V2 only allows the creation of `REGULAR` items.
+ The type of a [CatalogItem](#type-catalogitem). Connect V2 only allows the creation of `REGULAR` or `APPOINTMENTS_SERVICE` items.
 
 ## Properties
 Name | Type

data/docs/CatalogItemVariation.md

@@ -20,6 +20,7 @@ Name | Type | Description | Notes
 **inventory_alert_threshold** | **Integer** | If the inventory quantity for the variation is less than or equal to this value and `inventory_alert_type` is `LOW_QUANTITY`, the variation displays an alert in the merchant dashboard.  This value is always an integer. | [optional] 
 **user_data** | **String** | Arbitrary user metadata to associate with the item variation. Cannot exceed 255 characters. Searchable. | [optional] 
 **service_duration** | **Integer** | If the [CatalogItem](#type-catalogitem) that owns this item variation is of type `APPOINTMENTS_SERVICE`, then this is the duration of the service in milliseconds. For example, a 30 minute appointment would have the value `1800000`, which is equal to 30 (minutes) * 60 (seconds per minute) * 1000 (milliseconds per second). | [optional] 
+**item_option_values** | [**Array<CatalogItemOptionValueForItemVariation>**](CatalogItemOptionValueForItemVariation.md) | List of item option values associated with this item variation. Listed in the same order as the item options of the parent item. | [optional] 
 **measurement_unit_id** | **String** | ID of the ‘CatalogMeasurementUnit’ that is used to measure the quantity sold of this item variation. If left unset, the item will be sold in whole quantities. | [optional] 
 
 

data/docs/CatalogObject.md

@@ -29,5 +29,7 @@ Name | Type | Description | Notes
 **pricing_rule_data** | [**CatalogPricingRule**](CatalogPricingRule.md) | Structured data for a [CatalogPricingRule](#type-catalogpricingrule), set for CatalogObjects of type `PRICING_RULE`. | [optional] 
 **image_data** | [**CatalogImage**](CatalogImage.md) | Structured data for a [CatalogImage](#type-catalogimage), set for CatalogObjects of type `IMAGE`. | [optional] 
 **measurement_unit_data** | [**CatalogMeasurementUnit**](CatalogMeasurementUnit.md) | Structured data for a [CatalogMeasurementUnit](#type-catalogmeasurementunit), set for CatalogObjects of type `MEASUREMENT_UNIT`. | [optional] 
+**item_option_data** | [**CatalogItemOption**](CatalogItemOption.md) | Structured data for a [CatalogItemOption](#type-catalogitemoption), set for CatalogObjects of type `ITEM_OPTION`. | [optional] 
+**item_option_value_data** | [**CatalogItemOptionValue**](CatalogItemOptionValue.md) | Structured data for a [CatalogItemOptionValue](#type-catalogitemoptionvalue), set for CatalogObjects of type `ITEM_OPTION_VAL`. | [optional] 
 
 

data/docs/CatalogObjectType.md

@@ -18,5 +18,8 @@ Name | Type
 **PRICING_RULE** | string
 **PRODUCT_SET** | string
 **TIME_PERIOD** | string
+**MEASUREMENT_UNIT** | string
+**ITEM_OPTION** | string
+**ITEM_OPTION_VAL** | string
 
 

data/docs/CatalogQuery.md

@@ -14,5 +14,7 @@ Name | Type | Description | Notes
 **text_query** | [**CatalogQueryText**](CatalogQueryText.md) | A query that returns only objects whose searchable attributes contain all of the given keywords as prefixes. For example, if a [CatalogItem](#type-catalogitem) contains attributes `{\"name\": \"t-shirt\"}` and `{\"description\": \"Small, Purple\"}`, it will be matched by the query `{\"keywords\": [\"shirt\", \"sma\", \"purp\"]}`. | [optional] 
 **items_for_tax_query** | [**CatalogQueryItemsForTax**](CatalogQueryItemsForTax.md) | A query that returns all [CatalogItem](#type-catalogitem)s that have any of the given [CatalogTax](#type-catalogtax)es enabled. | [optional] 
 **items_for_modifier_list_query** | [**CatalogQueryItemsForModifierList**](CatalogQueryItemsForModifierList.md) | A query that returns all [CatalogItem](#type-catalogitem)s that have any of the given [CatalogModifierList](#type-catalogmodifierlist)s enabled. | [optional] 
+**items_for_item_options_query** | [**CatalogQueryItemsForItemOptions**](CatalogQueryItemsForItemOptions.md) | A query that returns all [CatalogItem](#type-catalogitem)s that have all of the given [CatalogItemOption](#type-catalogitemoption)s. | [optional] 
+**item_variations_for_item_option_values_query** | [**CatalogQueryItemVariationsForItemOptionValues**](CatalogQueryItemVariationsForItemOptionValues.md) | A query that returns all [CatalogItemVariation](#type-catalogitemvariations)s that have all of the given [CatalogItemOption](#type-catalogitemoption) values. | [optional] 
 
 

data/docs/CatalogQueryItemVariationsForItemOptionValues.md

@@ -0,0 +1,12 @@
+# SquareConnect::CatalogQueryItemVariationsForItemOptionValues
+
+### Description
+
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**item_option_value_ids** | **Array<String>** | A set of [CatalogItemOptionValue](#type-catalogitemoptionvalue) IDs to be used to find associated [CatalogItemVariation](#type-catalogitemvariation)s. All ItemVariations that contain all of the given Item Option Values (in any order) will be returned. | [optional] 
+
+

data/docs/CatalogQueryItemsForItemOptions.md

@@ -0,0 +1,12 @@
+# SquareConnect::CatalogQueryItemsForItemOptions
+
+### Description
+
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**item_option_ids** | **Array<String>** | A set of [CatalogItemOption](#type-catalogitemoption) IDs to be used to find associated [CatalogItem](#type-catalogitem)s. All Items that contain all of the given Item Options (in any order) will be returned. | [optional] 
+
+

data/lib/square_connect.rb

@@ -49,6 +49,10 @@ require 'square_connect/models/catalog_info_response'
 require 'square_connect/models/catalog_info_response_limits'
 require 'square_connect/models/catalog_item'
 require 'square_connect/models/catalog_item_modifier_list_info'
+require 'square_connect/models/catalog_item_option'
+require 'square_connect/models/catalog_item_option_for_item'
+require 'square_connect/models/catalog_item_option_value'
+require 'square_connect/models/catalog_item_option_value_for_item_variation'
 require 'square_connect/models/catalog_item_product_type'
 require 'square_connect/models/catalog_item_variation'
 require 'square_connect/models/catalog_measurement_unit'
@@ -64,6 +68,8 @@ require 'square_connect/models/catalog_pricing_type'
 require 'square_connect/models/catalog_product_set'
 require 'square_connect/models/catalog_query'
 require 'square_connect/models/catalog_query_exact'
+require 'square_connect/models/catalog_query_item_variations_for_item_option_values'
+require 'square_connect/models/catalog_query_items_for_item_options'
 require 'square_connect/models/catalog_query_items_for_modifier_list'
 require 'square_connect/models/catalog_query_items_for_tax'
 require 'square_connect/models/catalog_query_prefix'

data/lib/square_connect/api_client.rb

@@ -30,7 +30,7 @@ module SquareConnect
       @config = config
 
       # Construct user agent string. Returns slightly different string for JRuby
-      @user_agent = "Square-Connect-Ruby/2.20190710.0"
+      @user_agent = "Square-Connect-Ruby/2.20190724.0"
 
       @default_headers = {
         'Content-Type' => "application/json",

data/lib/square_connect/models/catalog_item.rb

@@ -45,12 +45,15 @@ module SquareConnect
     # A list of [CatalogObject](#type-catalogobject)s containing the [CatalogItemVariation](#type-catalogitemvariation)s for this item.  Maximum: 250 item variations
     attr_accessor :variations
 
-    # The product type of the item. May not be changed once an item has been created.  Only items of product type `REGULAR` may be created by this API; items with other product types are read-only. See [CatalogItemProductType](#type-catalogitemproducttype) for possible values
+    # The product type of the item. May not be changed once an item has been created.  Only items of product type `REGULAR` or `APPOINTMENTS_SERVICE` may be created by this API; items with other product types are read-only. See [CatalogItemProductType](#type-catalogitemproducttype) for possible values
     attr_accessor :product_type
 
     # If `false`, the Square Point of Sale app will present the [CatalogItem](#type-catalogitem)'s details screen immediately, allowing the merchant to choose [CatalogModifier](#type-catalogmodifier)s before adding the item to the cart.  This is the default behavior.  If `true`, the Square Point of Sale app will immediately add the item to the cart with the pre-selected modifiers, and merchants can edit modifiers by drilling down onto the item's details.  Third-party clients are encouraged to implement similar behaviors.
     attr_accessor :skip_modifier_screen
 
+    # List of item options IDs for this item. Used to manage and group item variations in a specified order.  Maximum: 6 item options.
+    attr_accessor :item_options
+
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
@@ -67,7 +70,8 @@ module SquareConnect
         :'modifier_list_info' => :'modifier_list_info',
         :'variations' => :'variations',
         :'product_type' => :'product_type',
-        :'skip_modifier_screen' => :'skip_modifier_screen'
+        :'skip_modifier_screen' => :'skip_modifier_screen',
+        :'item_options' => :'item_options'
       }
     end
 
@@ -86,7 +90,8 @@ module SquareConnect
         :'modifier_list_info' => :'Array<CatalogItemModifierListInfo>',
         :'variations' => :'Array<CatalogObject>',
         :'product_type' => :'String',
-        :'skip_modifier_screen' => :'BOOLEAN'
+        :'skip_modifier_screen' => :'BOOLEAN',
+        :'item_options' => :'Array<CatalogItemOptionForItem>'
       }
     end
 
@@ -156,6 +161,12 @@ module SquareConnect
         self.skip_modifier_screen = attributes[:'skip_modifier_screen']
       end
 
+      if attributes.has_key?(:'item_options')
+        if (value = attributes[:'item_options']).is_a?(Array)
+          self.item_options = value
+        end
+      end
+
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -188,7 +199,8 @@ module SquareConnect
           modifier_list_info == o.modifier_list_info &&
           variations == o.variations &&
           product_type == o.product_type &&
-          skip_modifier_screen == o.skip_modifier_screen
+          skip_modifier_screen == o.skip_modifier_screen &&
+          item_options == o.item_options
     end
 
     # @see the `==` method
@@ -200,7 +212,7 @@ module SquareConnect
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [name, description, abbreviation, label_color, available_online, available_for_pickup, available_electronically, category_id, tax_ids, modifier_list_info, variations, product_type, skip_modifier_screen].hash
+      [name, description, abbreviation, label_color, available_online, available_for_pickup, available_electronically, category_id, tax_ids, modifier_list_info, variations, product_type, skip_modifier_screen, item_options].hash
     end
 
     # Builds the object from hash

data/lib/square_connect/models/catalog_item_option.rb

@@ -0,0 +1,238 @@
+=begin
+#Square Connect API
+
+OpenAPI spec version: 2.0
+Contact: developers@squareup.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require 'date'
+
+module SquareConnect
+  # A group of variations for a [CatalogItem](#type-catalogitem)'s.
+  class CatalogItemOption
+    # The item option's display name for the seller. Must be unique across all item options. Searchable.
+    attr_accessor :name
+
+    # The item option's display name for the customer. Searchable.
+    attr_accessor :display_name
+
+    # The item option's human-readable description. Displays for in the Square Point of Sale app for the seller and in the Online Store or on receipts for the buyer.
+    attr_accessor :description
+
+    # If true, display colors for entries in `values` when present.
+    attr_accessor :show_colors
+
+    # A list of [CatalogObject](#type-catalogobject)s containing the [CatalogItemOptionValue](#type-catalogitemoptionvalue)s for this item.
+    attr_accessor :values
+
+    # The number of [CatalogItem](#type-catalogitem)s currently associated with this item option. Present only if the `include_counts` was specified in the request. Any count over 100 will be returned as `100`.
+    attr_accessor :item_count
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'display_name' => :'display_name',
+        :'description' => :'description',
+        :'show_colors' => :'show_colors',
+        :'values' => :'values',
+        :'item_count' => :'item_count'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'name' => :'String',
+        :'display_name' => :'String',
+        :'description' => :'String',
+        :'show_colors' => :'BOOLEAN',
+        :'values' => :'Array<CatalogObject>',
+        :'item_count' => :'Integer'
+      }
+    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?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.has_key?(:'display_name')
+        self.display_name = attributes[:'display_name']
+      end
+
+      if attributes.has_key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.has_key?(:'show_colors')
+        self.show_colors = attributes[:'show_colors']
+      end
+
+      if attributes.has_key?(:'values')
+        if (value = attributes[:'values']).is_a?(Array)
+          self.values = value
+        end
+      end
+
+      if attributes.has_key?(:'item_count')
+        self.item_count = attributes[:'item_count']
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      return 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 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 &&
+          name == o.name &&
+          display_name == o.display_name &&
+          description == o.description &&
+          show_colors == o.show_colors &&
+          values == o.values &&
+          item_count == o.item_count
+    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
+      [name, display_name, description, show_colors, values, item_count].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 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 = SquareConnect.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