square_connect 2.20190313.1.282 → 2.20190327.1.292

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.20190313.1"
+      @user_agent = "Square-Connect-Ruby/2.20190327.1"
 
       @default_headers = {
         'Content-Type' => "application/json",

data/lib/square_connect/models/address.rb

@@ -45,7 +45,7 @@ module SquareConnect
     # The address's postal code.
     attr_accessor :postal_code
 
-    # The address's country, in ISO 3166-1-alpha-2 format.
+    # The address's country, in ISO 3166-1-alpha-2 format. See [Country](#type-country) for possible values
     attr_accessor :country
 
     # Optional first name when it's representing recipient.

data/lib/square_connect/models/batch_retrieve_inventory_changes_request.rb

@@ -18,10 +18,10 @@ module SquareConnect
     # Filters results by [Location](#type-location) ID. Only applied when set. Default: unset.
     attr_accessor :location_ids
 
-    # Filters results by [InventoryChangeType](#type-inventorychangetype). Default: [`PHYSICAL_COUNT`, `ADJUSTMENT`]. `TRANSFER` is not supported as a filter.
+    # Filters results by [InventoryChangeType](#type-inventorychangetype). Default: [`PHYSICAL_COUNT`, `ADJUSTMENT`]. `TRANSFER` is not supported as a filter. See [InventoryChangeType](#type-inventorychangetype) for possible values
     attr_accessor :types
 
-    # Filters `ADJUSTMENT` query results by [InventoryState](#type-inventorystate). Only applied when set. Default: unset.
+    # Filters `ADJUSTMENT` query results by [InventoryState](#type-inventorystate). Only applied when set. Default: unset. See [InventoryState](#type-inventorystate) for possible values
     attr_accessor :states
 
     # Provided as an RFC 3339 timestamp. Returns results whose `created_at` or `calculated_at` value is after the given time. Default: UNIX epoch (`1970-01-01T00:00:00Z`).

data/lib/square_connect/models/card.rb

@@ -15,7 +15,7 @@ module SquareConnect
     # Unique ID for this card. Generated by Square.
     attr_accessor :id
 
-    # The card's brand (such as `VISA`). See [CardBrand](#type-cardbrand) for all possible values.
+    # The card's brand (such as `VISA`). See [CardBrand](#type-cardbrand) for possible values
     attr_accessor :card_brand
 
     # The last 4 digits of the card number.

data/lib/square_connect/models/catalog_discount.rb

@@ -15,7 +15,7 @@ module SquareConnect
     # The discount's name. Searchable. This field has max length of 255 Unicode code points.
     attr_accessor :name
 
-    # Indicates whether the discount is a fixed amount or percentage, or entered at the time of sale. See [CatalogDiscountType](#type-catalogdiscounttype) for all possible values.
+    # Indicates whether the discount is a fixed amount or percentage, or entered at the time of sale. See [CatalogDiscountType](#type-catalogdiscounttype) for possible values
     attr_accessor :discount_type
 
     # The percentage of the discount as a string representation of a decimal number, using a `.` as the decimal separator and without a `%` sign. A value of `7.5` corresponds to `7.5%`. Specify a percentage of `0` if `discount_type` is `VARIABLE_PERCENTAGE`.  Do not include this field for amount-based or variable discounts.

data/lib/square_connect/models/catalog_image.rb

@@ -0,0 +1,206 @@
+=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
+  # An image file to use in Square catalogs. Can be associated with catalog items, item variations, and categories.
+  class CatalogImage
+    # The internal name of this image. Identifies this image in calls to the Connect APIs.
+    attr_accessor :name
+
+    # The URL of this image. Generated by Square after an image is uploaded to the CreateCatalogImage endpoint.
+    attr_accessor :url
+
+    # A caption that describes what is shown in the image. Displayed in the Square Online Store.
+    attr_accessor :caption
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'url' => :'url',
+        :'caption' => :'caption'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'name' => :'String',
+        :'url' => :'String',
+        :'caption' => :'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?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.has_key?(:'url')
+        self.url = attributes[:'url']
+      end
+
+      if attributes.has_key?(:'caption')
+        self.caption = attributes[:'caption']
+      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 &&
+          url == o.url &&
+          caption == o.caption
+    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, url, caption].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

data/lib/square_connect/models/catalog_item.rb

@@ -42,13 +42,13 @@ module SquareConnect
     # 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`.
     attr_accessor :modifier_list_info
 
-    # The URL of an image representing this item.
+    # __Deprecated__. The URL of an image representing this item. Deprecated in favor of `image_id` in [`CatalogObject`](#type-catalogobject).
     attr_accessor :image_url
 
     # A list of [CatalogObject](#type-catalogobject)s containing the [CatalogItemVariation](#type-catalogitemvariation)s for this item.
     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 all possible values.
+    # 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
     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.

data/lib/square_connect/models/catalog_item_variation.rb

@@ -27,7 +27,7 @@ module SquareConnect
     # The order in which this item variation should be displayed. This value is read-only. On writes, the ordinal for each item variation within a parent [CatalogItem](#type-catalogitem) is set according to the item variations's position. On reads, the value is not guaranteed to be sequential or unique.
     attr_accessor :ordinal
 
-    # Indicates whether the item variation's price is fixed or determined at the time of sale. See [CatalogPricingType](#type-catalogpricingtype) for all possible values.
+    # Indicates whether the item variation's price is fixed or determined at the time of sale. See [CatalogPricingType](#type-catalogpricingtype) for possible values
     attr_accessor :pricing_type
 
     # The item variation's price, if fixed pricing is used.
@@ -39,7 +39,7 @@ module SquareConnect
     # If `true`, inventory tracking is active for the variation.
     attr_accessor :track_inventory
 
-    # Indicates whether the item variation displays an alert when its inventory quantity is less than or equal to its `inventory_alert_threshold`. See [InventoryAlertType](#type-inventoryalerttype) for all possible values.
+    # Indicates whether the item variation displays an alert when its inventory quantity is less than or equal to its `inventory_alert_threshold`. See [InventoryAlertType](#type-inventoryalerttype) for possible values
     attr_accessor :inventory_alert_type
 
     # 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.

data/lib/square_connect/models/catalog_modifier_list.rb

@@ -15,7 +15,7 @@ module SquareConnect
     # The [CatalogModifierList](#type-catalogmodifierlist)'s name. Searchable. This field has max length of 255 Unicode code points.
     attr_accessor :name
 
-    # Indicates whether multiple options from the [CatalogModifierList](#type-catalogmodifierlist) can be applied to a single [CatalogItem](#type-catalogitem). See [CatalogModifierListSelectionType](#type-catalogmodifierlistselectiontype) for all possible values.
+    # Indicates whether multiple options from the [CatalogModifierList](#type-catalogmodifierlist) can be applied to a single [CatalogItem](#type-catalogitem). See [CatalogModifierListSelectionType](#type-catalogmodifierlistselectiontype) for possible values
     attr_accessor :selection_type
 
     # The options included in the [CatalogModifierList](#type-catalogmodifierlist). You must include at least one [CatalogModifier](#type-catalogmodifier). Each [CatalogObject](#type-catalogobject) must have type `MODIFIER` and contain [CatalogModifier](#type-catalogmodifier) data.

data/lib/square_connect/models/catalog_object.rb

@@ -12,7 +12,7 @@ require 'date'
 module SquareConnect
   # The wrapper object for object types in the Catalog data model. The type of a particular `CatalogObject` is determined by the value of `type` and only the corresponding data field may be set.  - if type = `ITEM`, only `item_data` will be populated and it will contain a valid [CatalogItem](#type-catalogitem) object. - if type = `ITEM_VARIATION`, only `item_variation_data` will be populated and it will contain a valid [CatalogItemVariation](#type-catalogitemvariation) object. - if type = `MODIFIER`, only `modifier_data` will be populated and it will contain a valid [CatalogModifier](#type-catalogmodifier) object. - if type = `MODIFIER_LIST`, only `modifier_list_data` will be populated and it will contain a valid [CatalogModifierList](#type-catalogmodifierlist) object. - if type = `CATEGORY`, only `category_data` will be populated and it will contain a valid [CatalogCategory](#type-catalogcategory) object. - if type = `DISCOUNT`, only `discount_data` will be populated and it will contain a valid [CatalogDiscount](#type-catalogdiscount) object. - if type = `TAX`, only `tax_data` will be populated and it will contain a valid [CatalogTax](#type-catalogtax) object.  For a more detailed discussion of the Catalog data model, please see the [Catalog Overview](/products/catalog/overview).
   class CatalogObject
-    # The type of this object. Each object type has expected properties expressed in a structured format within its corresponding `*_data` field below.  See [CatalogObjectType](#type-catalogobjecttype) for all possible values.
+    # The type of this object. Each object type has expected properties expressed in a structured format within its corresponding `*_data` field below. See [CatalogObjectType](#type-catalogobjecttype) for possible values
     attr_accessor :type
 
     # An identifier to reference this object in the catalog. When a new CatalogObject is inserted, the client should set the id to a temporary identifier starting with a `'#'` character. Other objects being inserted or updated within the same request may use this identifier to refer to the new object.  When the server receives the new object, it will supply a unique identifier that replaces the temporary identifier for all future references.
@@ -39,6 +39,9 @@ module SquareConnect
     # A list of locations where the object is not present, even if `present_at_all_locations` is `true`.
     attr_accessor :absent_at_location_ids
 
+    # Identifies the `CatalogImage` attached to this `CatalogObject`.
+    attr_accessor :image_id
+
     # Structured data for a [CatalogItem](#type-catalogitem), set for CatalogObjects of type `ITEM`.
     attr_accessor :item_data
 
@@ -60,6 +63,9 @@ module SquareConnect
     # Structured data for a [CatalogModifier](#type-catalogmodifier), set for CatalogObjects of type `MODIFIER`.
     attr_accessor :modifier_data
 
+    # Structured data for a [CatalogImage](#type-catalogimage), set for CatalogObjects of type `IMAGE`.
+    attr_accessor :image_data
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -94,13 +100,15 @@ module SquareConnect
         :'present_at_all_locations' => :'present_at_all_locations',
         :'present_at_location_ids' => :'present_at_location_ids',
         :'absent_at_location_ids' => :'absent_at_location_ids',
+        :'image_id' => :'image_id',
         :'item_data' => :'item_data',
         :'category_data' => :'category_data',
         :'item_variation_data' => :'item_variation_data',
         :'tax_data' => :'tax_data',
         :'discount_data' => :'discount_data',
         :'modifier_list_data' => :'modifier_list_data',
-        :'modifier_data' => :'modifier_data'
+        :'modifier_data' => :'modifier_data',
+        :'image_data' => :'image_data'
       }
     end
 
@@ -116,13 +124,15 @@ module SquareConnect
         :'present_at_all_locations' => :'BOOLEAN',
         :'present_at_location_ids' => :'Array<String>',
         :'absent_at_location_ids' => :'Array<String>',
+        :'image_id' => :'String',
         :'item_data' => :'CatalogItem',
         :'category_data' => :'CatalogCategory',
         :'item_variation_data' => :'CatalogItemVariation',
         :'tax_data' => :'CatalogTax',
         :'discount_data' => :'CatalogDiscount',
         :'modifier_list_data' => :'CatalogModifierList',
-        :'modifier_data' => :'CatalogModifier'
+        :'modifier_data' => :'CatalogModifier',
+        :'image_data' => :'CatalogImage'
       }
     end
 
@@ -176,6 +186,10 @@ module SquareConnect
         end
       end
 
+      if attributes.has_key?(:'image_id')
+        self.image_id = attributes[:'image_id']
+      end
+
       if attributes.has_key?(:'item_data')
         self.item_data = attributes[:'item_data']
       end
@@ -204,6 +218,10 @@ module SquareConnect
         self.modifier_data = attributes[:'modifier_data']
       end
 
+      if attributes.has_key?(:'image_data')
+        self.image_data = attributes[:'image_data']
+      end
+
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -229,7 +247,7 @@ module SquareConnect
     # @return true if the model is valid
     def valid?
       return false if @type.nil?
-      type_validator = EnumAttributeValidator.new('String', ["ITEM", "CATEGORY", "ITEM_VARIATION", "TAX", "DISCOUNT", "MODIFIER_LIST", "MODIFIER"])
+      type_validator = EnumAttributeValidator.new('String', ["ITEM", "IMAGE", "CATEGORY", "ITEM_VARIATION", "TAX", "DISCOUNT", "MODIFIER_LIST", "MODIFIER"])
       return false unless type_validator.valid?(@type)
       return false if @id.nil?
       return false if @id.to_s.length < 1
@@ -239,7 +257,7 @@ module SquareConnect
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)
-      validator = EnumAttributeValidator.new('String', ["ITEM", "CATEGORY", "ITEM_VARIATION", "TAX", "DISCOUNT", "MODIFIER_LIST", "MODIFIER"])
+      validator = EnumAttributeValidator.new('String', ["ITEM", "IMAGE", "CATEGORY", "ITEM_VARIATION", "TAX", "DISCOUNT", "MODIFIER_LIST", "MODIFIER"])
       unless validator.valid?(type)
         fail ArgumentError, "invalid value for 'type', must be one of #{validator.allowable_values}."
       end
@@ -274,13 +292,15 @@ module SquareConnect
           present_at_all_locations == o.present_at_all_locations &&
           present_at_location_ids == o.present_at_location_ids &&
           absent_at_location_ids == o.absent_at_location_ids &&
+          image_id == o.image_id &&
           item_data == o.item_data &&
           category_data == o.category_data &&
           item_variation_data == o.item_variation_data &&
           tax_data == o.tax_data &&
           discount_data == o.discount_data &&
           modifier_list_data == o.modifier_list_data &&
-          modifier_data == o.modifier_data
+          modifier_data == o.modifier_data &&
+          image_data == o.image_data
     end
 
     # @see the `==` method
@@ -292,7 +312,7 @@ module SquareConnect
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [type, id, updated_at, version, is_deleted, catalog_v1_ids, present_at_all_locations, present_at_location_ids, absent_at_location_ids, item_data, category_data, item_variation_data, tax_data, discount_data, modifier_list_data, modifier_data].hash
+      [type, id, updated_at, version, is_deleted, catalog_v1_ids, present_at_all_locations, present_at_location_ids, absent_at_location_ids, image_id, item_data, category_data, item_variation_data, tax_data, discount_data, modifier_list_data, modifier_data, image_data].hash
     end
 
     # Builds the object from hash

data/lib/square_connect/models/catalog_object_type.rb

@@ -13,6 +13,7 @@ module SquareConnect
   class CatalogObjectType
     
     ITEM = "ITEM".freeze
+    IMAGE = "IMAGE".freeze
     CATEGORY = "CATEGORY".freeze
     ITEM_VARIATION = "ITEM_VARIATION".freeze
     TAX = "TAX".freeze

data/lib/square_connect/models/catalog_query_sorted_attribute.rb

@@ -18,7 +18,7 @@ module SquareConnect
     # The first attribute value to be returned by the query. Ascending sorts will return only objects with this value or greater, while descending sorts will return only objects with this value or less. If unset, start at the beginning (for ascending sorts) or end (for descending sorts).
     attr_accessor :initial_attribute_value
 
-    # The desired [SortOrder](#type-sortorder), `\"ASC\"` (ascending) or `\"DESC\"` (descending).
+    # The desired [SortOrder](#type-sortorder), `\"ASC\"` (ascending) or `\"DESC\"` (descending). See [SortOrder](#type-sortorder) for possible values
     attr_accessor :sort_order
 
     class EnumAttributeValidator